RubyGems - mondrian-olap - Versions diffs - 0.1.0 - Mend

mondrian-olap 0.1.0

Files changed (41) hide show

data/.rspec +2 -0
data/Gemfile +15 -0
data/LICENSE-Mondrian.html +259 -0
data/LICENSE.txt +22 -0
data/README.rdoc +219 -0
data/RUNNING_TESTS.rdoc +41 -0
data/Rakefile +46 -0
data/VERSION +1 -0
data/lib/mondrian-olap.rb +1 -0
data/lib/mondrian/jars/commons-collections-3.1.jar +0 -0
data/lib/mondrian/jars/commons-dbcp-1.2.1.jar +0 -0
data/lib/mondrian/jars/commons-logging-1.0.4.jar +0 -0
data/lib/mondrian/jars/commons-math-1.0.jar +0 -0
data/lib/mondrian/jars/commons-pool-1.2.jar +0 -0
data/lib/mondrian/jars/commons-vfs-1.0.jar +0 -0
data/lib/mondrian/jars/eigenbase-properties.jar +0 -0
data/lib/mondrian/jars/eigenbase-resgen.jar +0 -0
data/lib/mondrian/jars/eigenbase-xom.jar +0 -0
data/lib/mondrian/jars/javacup.jar +0 -0
data/lib/mondrian/jars/log4j-1.2.8.jar +0 -0
data/lib/mondrian/jars/log4j.properties +18 -0
data/lib/mondrian/jars/mondrian.jar +0 -0
data/lib/mondrian/jars/olap4j.jar +0 -0
data/lib/mondrian/olap.rb +14 -0
data/lib/mondrian/olap/connection.rb +122 -0
data/lib/mondrian/olap/cube.rb +236 -0
data/lib/mondrian/olap/query.rb +313 -0
data/lib/mondrian/olap/result.rb +155 -0
data/lib/mondrian/olap/schema.rb +158 -0
data/lib/mondrian/olap/schema_element.rb +123 -0
data/mondrian-olap.gemspec +116 -0
data/spec/connection_spec.rb +56 -0
data/spec/cube_spec.rb +259 -0
data/spec/fixtures/MondrianTest.xml +128 -0
data/spec/fixtures/MondrianTestOracle.xml +128 -0
data/spec/query_spec.rb +582 -0
data/spec/rake_tasks.rb +185 -0
data/spec/schema_definition_spec.rb +345 -0
data/spec/spec_helper.rb +67 -0
data/spec/support/matchers/be_like.rb +24 -0
metadata +217 -0

data/.rspec ADDED

	@@ -0,0 +1,2 @@
1	+ --color
2	+ --backtrace

data/Gemfile ADDED

@@ -0,0 +1,15 @@
+source 'http://rubygems.org'
+gem 'nokogiri', '~> 1.5.0.beta.4'
+group :development do
+  gem 'jruby-openssl'
+  gem 'jeweler', '~> 1.5.2'
+  gem 'rspec', '~> 2.5'
+  gem 'autotest'
+  gem 'jdbc-mysql'
+  gem 'jdbc-postgres'
+  gem 'activerecord', '~> 3.0.5'
+  gem 'activerecord-jdbc-adapter'
+  gem 'activerecord-oracle_enhanced-adapter', :require => false
+end

data/LICENSE-Mondrian.html ADDED

@@ -0,0 +1,259 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml"><head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Eclipse Public License - Version 1.0</title>
+<style type="text/css">
+  body {
+    size: 8.5in 11.0in;
+    margin: 0.25in 0.5in 0.25in 0.5in;
+    tab-interval: 0.5in;
+    }
+  p {
+    margin-left: auto;
+    margin-top:  0.5em;
+    margin-bottom: 0.5em;
+    }
+  p.list {
+  	margin-left: 0.5in;
+    margin-top:  0.05em;
+    margin-bottom: 0.05em;
+    }
+  </style>
+</head><body lang="EN-US">
+<h2>Eclipse Public License - v 1.0</h2>
+<p>THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
+PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR
+DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS
+AGREEMENT.</p>
+<p><b>1. DEFINITIONS</b></p>
+<p>"Contribution" means:</p>
+<p class="list">a) in the case of the initial Contributor, the initial
+code and documentation distributed under this Agreement, and</p>
+<p class="list">b) in the case of each subsequent Contributor:</p>
+<p class="list">i) changes to the Program, and</p>
+<p class="list">ii) additions to the Program;</p>
+<p class="list">where such changes and/or additions to the Program
+originate from and are distributed by that particular Contributor. A
+Contribution 'originates' from a Contributor if it was added to the
+Program by such Contributor itself or anyone acting on such
+Contributor's behalf. Contributions do not include additions to the
+Program which: (i) are separate modules of software distributed in
+conjunction with the Program under their own license agreement, and (ii)
+are not derivative works of the Program.</p>
+<p>"Contributor" means any person or entity that distributes
+the Program.</p>
+<p>"Licensed Patents" mean patent claims licensable by a
+Contributor which are necessarily infringed by the use or sale of its
+Contribution alone or when combined with the Program.</p>
+<p>"Program" means the Contributions distributed in accordance
+with this Agreement.</p>
+<p>"Recipient" means anyone who receives the Program under
+this Agreement, including all Contributors.</p>
+<p><b>2. GRANT OF RIGHTS</b></p>
+<p class="list">a) Subject to the terms of this Agreement, each
+Contributor hereby grants Recipient a non-exclusive, worldwide,
+royalty-free copyright license to reproduce, prepare derivative works
+of, publicly display, publicly perform, distribute and sublicense the
+Contribution of such Contributor, if any, and such derivative works, in
+source code and object code form.</p>
+<p class="list">b) Subject to the terms of this Agreement, each
+Contributor hereby grants Recipient a non-exclusive, worldwide,
+royalty-free patent license under Licensed Patents to make, use, sell,
+offer to sell, import and otherwise transfer the Contribution of such
+Contributor, if any, in source code and object code form. This patent
+license shall apply to the combination of the Contribution and the
+Program if, at the time the Contribution is added by the Contributor,
+such addition of the Contribution causes such combination to be covered
+by the Licensed Patents. The patent license shall not apply to any other
+combinations which include the Contribution. No hardware per se is
+licensed hereunder.</p>
+<p class="list">c) Recipient understands that although each Contributor
+grants the licenses to its Contributions set forth herein, no assurances
+are provided by any Contributor that the Program does not infringe the
+patent or other intellectual property rights of any other entity. Each
+Contributor disclaims any liability to Recipient for claims brought by
+any other entity based on infringement of intellectual property rights
+or otherwise. As a condition to exercising the rights and licenses
+granted hereunder, each Recipient hereby assumes sole responsibility to
+secure any other intellectual property rights needed, if any. For
+example, if a third party patent license is required to allow Recipient
+to distribute the Program, it is Recipient's responsibility to acquire
+that license before distributing the Program.</p>
+<p class="list">d) Each Contributor represents that to its knowledge it
+has sufficient copyright rights in its Contribution, if any, to grant
+the copyright license set forth in this Agreement.</p>
+<p><b>3. REQUIREMENTS</b></p>
+<p>A Contributor may choose to distribute the Program in object code
+form under its own license agreement, provided that:</p>
+<p class="list">a) it complies with the terms and conditions of this
+Agreement; and</p>
+<p class="list">b) its license agreement:</p>
+<p class="list">i) effectively disclaims on behalf of all Contributors
+all warranties and conditions, express and implied, including warranties
+or conditions of title and non-infringement, and implied warranties or
+conditions of merchantability and fitness for a particular purpose;</p>
+<p class="list">ii) effectively excludes on behalf of all Contributors
+all liability for damages, including direct, indirect, special,
+incidental and consequential damages, such as lost profits;</p>
+<p class="list">iii) states that any provisions which differ from this
+Agreement are offered by that Contributor alone and not by any other
+party; and</p>
+<p class="list">iv) states that source code for the Program is available
+from such Contributor, and informs licensees how to obtain it in a
+reasonable manner on or through a medium customarily used for software
+exchange.</p>
+<p>When the Program is made available in source code form:</p>
+<p class="list">a) it must be made available under this Agreement; and</p>
+<p class="list">b) a copy of this Agreement must be included with each
+copy of the Program.</p>
+<p>Contributors may not remove or alter any copyright notices contained
+within the Program.</p>
+<p>Each Contributor must identify itself as the originator of its
+Contribution, if any, in a manner that reasonably allows subsequent
+Recipients to identify the originator of the Contribution.</p>
+<p><b>4. COMMERCIAL DISTRIBUTION</b></p>
+<p>Commercial distributors of software may accept certain
+responsibilities with respect to end users, business partners and the
+like. While this license is intended to facilitate the commercial use of
+the Program, the Contributor who includes the Program in a commercial
+product offering should do so in a manner which does not create
+potential liability for other Contributors. Therefore, if a Contributor
+includes the Program in a commercial product offering, such Contributor
+("Commercial Contributor") hereby agrees to defend and
+indemnify every other Contributor ("Indemnified Contributor")
+against any losses, damages and costs (collectively "Losses")
+arising from claims, lawsuits and other legal actions brought by a third
+party against the Indemnified Contributor to the extent caused by the
+acts or omissions of such Commercial Contributor in connection with its
+distribution of the Program in a commercial product offering. The
+obligations in this section do not apply to any claims or Losses
+relating to any actual or alleged intellectual property infringement. In
+order to qualify, an Indemnified Contributor must: a) promptly notify
+the Commercial Contributor in writing of such claim, and b) allow the
+Commercial Contributor to control, and cooperate with the Commercial
+Contributor in, the defense and any related settlement negotiations. The
+Indemnified Contributor may participate in any such claim at its own
+expense.</p>
+<p>For example, a Contributor might include the Program in a commercial
+product offering, Product X. That Contributor is then a Commercial
+Contributor. If that Commercial Contributor then makes performance
+claims, or offers warranties related to Product X, those performance
+claims and warranties are such Commercial Contributor's responsibility
+alone. Under this section, the Commercial Contributor would have to
+defend claims against the other Contributors related to those
+performance claims and warranties, and if a court requires any other
+Contributor to pay any damages as a result, the Commercial Contributor
+must pay those damages.</p>
+<p><b>5. NO WARRANTY</b></p>
+<p>EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS
+PROVIDED 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. Each Recipient is solely
+responsible for determining the appropriateness of using and
+distributing the Program and assumes all risks associated with its
+exercise of rights under this Agreement , including but not limited to
+the risks and costs of program errors, compliance with applicable laws,
+damage to or loss of data, programs or equipment, and unavailability or
+interruption of operations.</p>
+<p><b>6. DISCLAIMER OF LIABILITY</b></p>
+<p>EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT
+NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING
+WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR
+DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
+HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</p>
+<p><b>7. GENERAL</b></p>
+<p>If any provision of this Agreement is invalid or unenforceable under
+applicable law, it shall not affect the validity or enforceability of
+the remainder of the terms of this Agreement, and without further action
+by the parties hereto, such provision shall be reformed to the minimum
+extent necessary to make such provision valid and enforceable.</p>
+<p>If Recipient institutes patent litigation against any entity
+(including a cross-claim or counterclaim in a lawsuit) alleging that the
+Program itself (excluding combinations of the Program with other
+software or hardware) infringes such Recipient's patent(s), then such
+Recipient's rights granted under Section 2(b) shall terminate as of the
+date such litigation is filed.</p>
+<p>All Recipient's rights under this Agreement shall terminate if it
+fails to comply with any of the material terms or conditions of this
+Agreement and does not cure such failure in a reasonable period of time
+after becoming aware of such noncompliance. If all Recipient's rights
+under this Agreement terminate, Recipient agrees to cease use and
+distribution of the Program as soon as reasonably practicable. However,
+Recipient's obligations under this Agreement and any licenses granted by
+Recipient relating to the Program shall continue and survive.</p>
+<p>Everyone is permitted to copy and distribute copies of this
+Agreement, but in order to avoid inconsistency the Agreement is
+copyrighted and may only be modified in the following manner. The
+Agreement Steward reserves the right to publish new versions (including
+revisions) of this Agreement from time to time. No one other than the
+Agreement Steward has the right to modify this Agreement. The Eclipse
+Foundation is the initial Agreement Steward. The Eclipse Foundation may
+assign the responsibility to serve as the Agreement Steward to a
+suitable separate entity. Each new version of the Agreement will be
+given a distinguishing version number. The Program (including
+Contributions) may always be distributed subject to the version of the
+Agreement under which it was received. In addition, after a new version
+of the Agreement is published, Contributor may elect to distribute the
+Program (including its Contributions) under the new version. Except as
+expressly stated in Sections 2(a) and 2(b) above, Recipient receives no
+rights or licenses to the intellectual property of any Contributor under
+this Agreement, whether expressly, by implication, estoppel or
+otherwise. All rights in the Program not expressly granted under this
+Agreement are reserved.</p>
+<p>This Agreement is governed by the laws of the State of New York and
+the intellectual property laws of the United States of America. No party
+to this Agreement will bring a legal action under this Agreement more
+than one year after the cause of action arose. Each party waives its
+rights to a jury trial in any resulting litigation.</p>
+</body></html>

data/LICENSE.txt ADDED

@@ -0,0 +1,22 @@
+(The MIT License)
+Copyright (c) 2010 Raimonds Simanovskis
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc ADDED

@@ -0,0 +1,219 @@
+= mondrian-olap
+JRuby gem for performing multidimensional queries of relational database data using Mondrian OLAP Java library.
+== DESCRIPTION
+SQL language is good for doing ad-hoc queries from relational databases but it becomes very complicated when doing more complex analytical queries to get summary results. Alternative approach is OLAP (On-Line Analytical Processing) databases and engines that provide easier multidimensional analysis of data at different summary levels.
+One of the most popular open-source OLAP engines is Mondrian (http://mondrian.pentaho.com). Mondrian OLAP engine can be put in front of relational SQL database and it provides MDX multidimensional query language which is much more suited for analytical purposes.
+mondrian-olap is JRuby gem which includes Mondrian OLAP engine and provides Ruby DSL for creating OLAP schemas on top of relational database schemas and provides MDX query language and query builder Ruby methods for making analytical queries.
+== USAGE
+=== Schema definition
+At first you need to define OLAP schema mapping to relational database schema tables and columns. OLAP schema consists of:
+* Cubes
+  Multidimensional cube is a collection of measures that can be accessed by dimensions. In relational database cubes are stored in fact tables with measure columns and dimension foreign key columns.
+* Dimensions
+  Dimension can be used in one cube (private) or in many cubes (shared). In relational database dimensions are stored in dimension tables.
+* Hierarchies and levels
+  Dimension has at least one primary hierarchy and optional additional hierarchies and each hierarchy has one or more levels. In relational database all levels can be stored in the same dimension table as different columns or can be stored also in several tables.
+* Members
+  Dimension hierarchy level values are called members.
+* Measures
+  Measures are values which can be accessed at detailed level or aggregated (e.g. as sum or average) at higher dimension hierarchy levels. In relational database measures are stored as columns in cube table.
+* Calculated measures
+  Calculated measures are not stored in database but calculated using specified formula from other measures.
+Read more about about defining Mondrian OLAP schema at http://mondrian.pentaho.com/documentation/schema.php.
+Here is example how to define OLAP schema and its mapping to relational database tables and columns using mondrian-olap:
+  require "rubygems"
+  require "mondrian-olap"
+  schema = Mondrian::OLAP::Schema.define do
+    cube 'Sales' do
+      table 'sales'
+      dimension 'Customers', :foreign_key => 'customer_id' do
+        hierarchy :has_all => true, :all_member_name => 'All Customers', :primary_key => 'id' do
+          table 'customers'
+          level 'Country', :column => 'country', :unique_members => true
+          level 'State Province', :column => 'state_province', :unique_members => true
+          level 'City', :column => 'city', :unique_members => false
+          level 'Name', :column => 'fullname', :unique_members => true
+        end
+      end
+      dimension 'Products', :foreign_key => 'product_id' do
+        hierarchy :has_all => true, :all_member_name => 'All Products',
+                  :primary_key => 'id', :primary_key_table => 'products' do
+          join :left_key => 'product_class_id', :right_key => 'id' do
+            table 'products'
+            table 'product_classes'
+          end
+          level 'Product Family', :table => 'product_classes', :column => 'product_family', :unique_members => true
+          level 'Brand Name', :table => 'products', :column => 'brand_name', :unique_members => false
+          level 'Product Name', :table => 'products', :column => 'product_name', :unique_members => true
+        end
+      end
+      dimension 'Time', :foreign_key => 'time_id', :type => 'TimeDimension' do
+        hierarchy :has_all => false, :primary_key => 'id' do
+          table 'time'
+          level 'Year', :column => 'the_year', :type => 'Numeric', :unique_members => true, :level_type => 'TimeYears'
+          level 'Quarter', :column => 'quarter', :unique_members => false, :level_type => 'TimeQuarters'
+          level 'Month', :column => 'month_of_year', :type => 'Numeric', :unique_members => false, :level_type => 'TimeMonths'
+        end
+        hierarchy 'Weekly', :has_all => false, :primary_key => 'id' do
+          table 'time'
+          level 'Year', :column => 'the_year', :type => 'Numeric', :unique_members => true, :level_type => 'TimeYears'
+          level 'Week', :column => 'weak_of_year', :type => 'Numeric', :unique_members => false, :level_type => 'TimeWeeks'
+        end
+      end
+      measure 'Unit Sales', :column => 'unit_sales', :aggregator => 'sum'
+      measure 'Store Sales', :column => 'store_sales', :aggregator => 'sum'
+    end
+  end
+=== Connection creation
+When schema is defined it is necessary to establish OLAP connection to database. Here is example how to connect to MySQL database using the schema object that was defined previously:
+  require "jdbc/mysql"
+  olap = Mondrian::OLAP::Connection.create(
+    :driver => 'mysql',
+    :host => 'localhost,
+    :database => 'mondrian_test',
+    :username => 'mondrian_user',
+    :password => 'secret'
+    :schema => schema
+  )
+=== MDX queries
+Mondrian OLAP provides MDX query language. Read more about MDX at http://mondrian.pentaho.com/documentation/mdx.php.
+mondrian-olap allows executing of MDX queries, for example query for "Get sales amount and number of units (on columns) of all product families (on rows) sold in California during Q1 of 2010":
+  result = olap.execute <<-MDX
+    SELECT  {[Measures].[Unit Sales], [Measures].[Store Sales]} ON COLUMNS,
+            {[Product].children} ON ROWS
+      FROM  [Sales]
+      WHERE ([Time].[2010].[Q1], [Customers].[USA].[CA])
+  MDX
+which would correspond to the following SQL query:
+  SELECT SUM(unit_sales) unit_sales_sum, SUM(store_sales) store_sales_sum
+  FROM sales
+    LEFT JOIN products ON sales.product_id = products.id
+    LEFT JOIN product_classes ON products.product_class_id = product_classes.id
+    LEFT JOIN time ON sales.time_id = time.id
+    LEFT JOIN customers ON sales.customer_id = customers.id
+  WHERE time.the_year = 2010 AND time.quarter = 'Q1'
+    AND customers.country = 'USA' AND customers.state_province = 'CA'
+  GROUP BY product_classes.product_family
+  ORDER BY product_classes.product_family
+and then get axis and cells of result object:
+  result.axes_count         # => 2
+  result.column_names       # => ["Unit Sales", "Store Sales"]
+  result.column_full_names  # => ["[Measures].[Unit Sales]", "[Measures].[Store Sales]"]
+  result.row_names          # => e.g. ["Drink", "Food", "Non-Consumable"]
+  result.row_full_names     # => e.g. ["[Product].[Drink]", "[Product].[Food]", "[Product].[Non-Consumable]"]
+  result.values             # => [[..., ...], [..., ...], [..., ...]]
+                            # (three rows, each row containing value for "unit sales" and "store sales")
+=== Query builder methods
+MDX queries could be built and executed also using Ruby methods in a similar way as ActiveRecord/Arel queries are made.
+Previous MDX query can be executed as:
+  olap.from('Sales').
+  columns('[Measures].[Unit Sales]', '[Measures].[Store Sales]').
+  rows('[Product].children').
+  where('[Time].[2010].[Q1]', '[Customers].[USA].[CA]')
+Here is example of more complex query "Get sales amount and profit % of top 50 products cross-joined with USA and Canada country sales during Q1 of 2010":
+  olap.from('Sales').
+  with_member('[Measures].[ProfitPct]').
+    as('Val((Measures.[Store Sales] - Measures.[Store Cost]) / Measures.[Store Sales])',
+    :format_string => 'Percent').
+  columns('[Measures].[Store Sales]', '[Measures].[ProfitPct]').
+  rows('[Product].children').crossjoin('[Customers].[Canada]', '[Customers].[USA]').
+    top_count(50, '[Measures].[Store Sales]')
+  where('[Time].[2010].[Q1]')
+See more examples of queries in spec/query_spec.rb.
+Currently there are query builder methods just for most frequently used MDX functions, there will be new query builder methods in next releases of mondrian-olap gem.
+=== Cube dimension and member queries
+mondrian-olap provides also methods for querying dimensions and members:
+  cube = olap.cube('Sales')
+  cube.dimension_names                    # => ['Measures', 'Customers', 'Products', 'Time']
+  cube.dimensions                         # => array of dimension objects
+  cube.dimension('Customers')             # => customers dimension object
+  cube.dimension('Time').hierarchy_names  # => ['Time', 'Time.Weekly']
+  cube.dimension('Time').hierarchies      # => array of hierarchy objects
+  cube.dimension('Customers').hierarchy   # => default customers dimension hierarchy
+  cube.dimension('Customers').hierarchy.level_names
+                                          # => ['(All)', 'Country', 'State Province', 'City', 'Name']
+  cube.dimension('Customers').hierarchy.levels
+                                          # => array of hierarchy level objects
+  cube.dimension('Customers').hierarchy.level('Country').members
+                                          # => array of all level members
+  cube.member('[Customers].[USA].[CA]')   # => lookup member by full name
+  cube.member('[Customers].[USA].[CA]').children
+                                          # => get all children of member in deeper hierarchy level
+  cube.member('[Customers].[USA]').descendants_at_level('City')
+                                          # => get all descendants of member in specified hierarchy level
+See more examples of dimension and member queries in spec/cube_spec.rb.
+== REQUIREMENTS
+mondrian-olap gem is compatible with JRuby versions 1.5 and 1.6 (have not been tested with earlier versions). mondrian-olap works only with JRuby and not with other Ruby implementations as it includes Mondrian OLAP Java libraries.
+mondrian-olap currently supports MySQL, PostgreSQL and Oracle databases. When using MySQL or PostgreSQL databases then install jdbc-mysql or jdbc-postgres gem and require "jdbc/mysql" or "jdbc/postgres" to load corresponding JDBC database driver. When using Oracle then include Oracle JDBC driver (ojdbc14.jar or ojdbc6.jar) in CLASSPATH or copy to JRUBY_HOME/lib.
+== INSTALL
+Install gem with:
+  gem install mondrian-olap
+or include in your project's Gemfile:
+  gem "mondrian-olap"
+== LINKS
+* Source code: http://github.com/rsim/mondrian-olap
+* Bug reports / Feature requests: http://github.com/rsim/mondrian-olap/issues
+* General discussions and questions at: http://groups.google.com/group/mondrian-olap
+== LICENSE
+mondrian-olap is released under the terms of MIT license; see LICENSE.txt.
+Mondrian OLAP Engine is released under the terms of the Eclipse Public
+License v1.0 (EPL); see LICENSE-Mondrian.html.