neo4j-core 0.0.4-java → 0.0.5-java

data/Gemfile

@@ -2,8 +2,8 @@ source :gemcutter
 
 gemspec
 
-gem 'neo4j-advanced', "1.7.0.alpha.1",  :require => false
-gem 'neo4j-enterprise', "1.7.0.alpha.1", :require => false
+gem 'neo4j-advanced', "1.7.M02",  :require => false
+gem 'neo4j-enterprise', "1.7.M02", :require => false
 
 group 'development' do
   gem 'guard'

data/lib/neo4j-core.rb

@@ -19,6 +19,7 @@ require 'neo4j-core/database'
 require 'neo4j-core/to_java'
 
 require 'neo4j-core/property/property'
+require 'neo4j-core/property/java'
 
 require 'neo4j-core/rels/rels'
 require 'neo4j-core/rels/traverser'

data/lib/neo4j-core/index/indexer.rb

@@ -17,55 +17,21 @@ module Neo4j
 
 
         def to_s
-          "Indexer @#{object_id} index on: [#{@config.fields.map{|f| @config.numeric?(f)? "#{f} (numeric)" : f}.join(', ')}]"
+          "Indexer @#{object_id} index on: [#{@config.fields.map { |f| @config.numeric?(f) ? "#{f} (numeric)" : f }.join(', ')}]"
         end
 
         # Add an index on a field so that it will be automatically updated by neo4j transactional events.
+        # Notice that if you want to numerical range queries then you should specify a field_type of either Fixnum or Float.
+        # The index type will by default be <tt>:exact</tt>.
+        # Index on property arrays are supported.
         #
-        # The index method takes an optional configuration hash which allows you to:
-        #
-        # @example Add an index on an a property
-        #
-        #   class Person
-        #     include Neo4j::NodeMixin
-        #     index :name
-        #   end
-        #
-        # When the property name is changed/deleted or the node created it will keep the lucene index in sync.
-        # You can then perform a lucene query like this: Person.find('name: andreas')
-        #
-        # @example Add index on other nodes.
-        #
-        #   class Person
-        #     include Neo4j::NodeMixin
-        #     has_n(:friends).to(Contact)
-        #     has_n(:known_by).from(:friends)
-        #     index :user_id, :via => :known_by
-        #   end
-        #
-        # Notice that you *must* specify an incoming relationship with the via key, as shown above.
-        # In the example above an index <tt>user_id</tt> will be added to all Person nodes which has a <tt>friends</tt> relationship
-        # that person with that user_id. This allows you to do lucene queries on your friends properties.
-        #
-        # @example Set the type value to index
-        #
-        #   class Person
-        #     include Neo4j::NodeMixin
-        #     property :height, :weight, :type => Float
-        #     index :height, :weight
-        #   end
-        #
-        # By default all values will be indexed as Strings.
-        # If you want for example to do a numerical range query you must tell Neo4j.rb to index it as a numeric value.
-        # You do that with the key <tt>type</tt> on the property.
-        #
-        # Supported values for <tt>:type</tt> is <tt>String</tt>, <tt>Float</tt>, <tt>Date</tt>, <tt>DateTime</tt> and <tt>Fixnum</tt>
-        #
-        # === For more information
+        # @example
+        #    MyIndex.index(:age, :field_type => Fixnum) # default :exact
+        #    MyIndex.index(:wheels, :field_type => Fixnum)
+        #    MyIndex.index(:description, :type => :fulltext)
         #
         # @see Neo4j::Core::Index::LuceneQuery
         # @see #find
-        #
         def index(*args)
           @config.index(args)
         end
@@ -96,11 +62,18 @@ module Neo4j
         # @see #index
         def add_index(entity, field, value)
           return false unless index?(field)
-          conv_value = indexed_value_for(field, value)
+          if (java_array?(value))
+            conv_value = value.map{|x| indexed_value_for(field, x)}.to_java(Java::OrgNeo4jIndexLucene::ValueContext)
+          else
+            conv_value = indexed_value_for(field, value)
+          end
           index = index_for_field(field.to_s)
           index.add(entity, field, conv_value)
         end
 
+        def java_array?(value)
+          value.respond_to?(:java_class) && value.java_class.to_s[0..0] == '['
+        end
 
         # Removes an index on the given entity
         # This is normally not needed since you can instead declare an index which will automatically keep
@@ -108,6 +81,7 @@ module Neo4j
         # @see #index
         def rm_index(entity, field, value)
           return false unless index?(field)
+          #return value.each {|x| rm_index(entity, field, x)} if value.respond_to?(:each)
           index_for_field(field).remove(entity, field, value)
         end
 
@@ -120,23 +94,33 @@ module Neo4j
         # (by Rack).
         #
         # @example with a block
-        #
         #   Person.find('name: kalle') {|query| puts "#{[*query].join(', )"}
         #
-        # @example
-        #
+        # @example using an exact lucene index
         #   query = Person.find('name: kalle')
         #   puts "First item #{query.first}"
         #   query.close
         #
-        # @return [Neo4j::Core::Index::LuceneQuery] a query object
+        # @example using an fulltext lucene index
+        #   query = Person.find('name: kalle', :type => :fulltext)
+        #   puts "First item #{query.first}"
+        #   query.close
+        #
+        # @example Sorting, descending by one property
+        #    Person.find({:name => 'kalle'}, :sort => {:name => :desc})
+        #
+        # @example Using the lucene java object
+        #   # using the Neo4j query method directly
+        #   # see, http://api.neo4j.org/1.6.1/org/neo4j/graphdb/index/ReadableIndex.html#query(java.lang.Object)
+        #   MyIndex.find('description: "hej"', :type => :fulltext, :wrapped => false).get_single
+        #
+        # @param [String, Hash] query the lucene query
+        # @param [Hash] params lucene configuration parameters
+        # @return [Neo4j::Core::Index::LuceneQuery] a query object which uses the builder pattern for creating compound and sort queries.
+        # @note You must specify the index type <tt>:fulltext<tt>) if the property is index using that index (default is <tt>:exact</tt>)
         def find(query, params = {})
           index = index_for_type(params[:type] || :exact)
-          if query.is_a?(Hash) && (query.include?(:conditions) || query.include?(:sort))
-            params.merge! query.reject { |k, _| k == :conditions }
-            query.delete(:sort)
-            query = query.delete(:conditions) if query.include?(:conditions)
-          end
+          query.delete(:sort) if query.is_a?(Hash) && query.include?(:sort)
           query = (params[:wrapped].nil? || params[:wrapped]) ? LuceneQuery.new(index, @config, query, params) : index.query(query)
 
           if block_given?

data/lib/neo4j-core/property/java.rb

@@ -0,0 +1,59 @@
+module Neo4j
+  module Core
+    module Property
+      # This module is only used for documentation purpose
+      # It simplify declares the java methods which are available Java org.neo4j.graphdb.PropertyContainer
+      # @see http://api.neo4j.org/1.6.1/org/neo4j/graphdb/PropertyContainer.html
+      module Java
+
+
+        # Get the GraphDatabaseService that this Node or Relationship belongs to.
+        # @return [Java::Neo4jGraphdbGraphDatabaseService]
+        def graph_database
+        end
+
+        # Returns the property value associated with the given key, or a default value.
+        # The value is of one of the valid property types, i.e. a Java primitive, a String or an array of any of the valid types.
+        # If there's no property associated with key an unchecked exception is raised.
+        # The idiomatic way to avoid an exception for an unknown key and instead get null back is to use a default value: Object valueOrNull = nodeOrRel.getProperty( key, null )
+        # @param [String] key the property key
+        # @param [String] default_value the default value that will be returned if no property value was associated with the given key
+        # @return [String,Fixnum,Boolean,Float,Array] ]the property value associated with the given key.
+        # @raise an exception if not given a default value and there is no property for the given key
+        # @see Neo4j::Core:Property#[]
+        def get_property(key, default_value = nil)
+        end
+
+        # @return all existing property keys, or an empty iterable if this property container has no properties.
+        def property_keys
+        end
+
+
+        # Removes the property associated with the given key and returns the old value.
+        # @param [String] key the name of the property
+        # @return [String,Fixnum,Boolean,Float,Array, nil] The old value or <tt>nil</tt> if there's no property associated with the key.
+        def remove_property(key)
+        end
+
+        # Sets the property value for the given key to value.
+        # The property value must be one of the valid property types, i.e:
+        # * boolean or boolean[]
+        # * byte or byte[]
+        # * short or short[]
+        # * int or int[]
+        # * long or long[]
+        # * float or float[]
+        # * double or double[]
+        # * char or char[]
+        # * java.lang.String or String[]
+        # Notice that JRuby does map Ruby primitive object (e.g. Fixnum) to java primitives automatically.
+        # Also, nil is not an accepted property value.
+        # @param [String] key the property key
+        # @param [String,Fixnum,Boolean,Float,Array] value
+        # @see Neo4j::Core::Property#[]=
+        def set_property(key, value)
+        end
+      end
+    end
+  end
+end

data/lib/neo4j-core/relationship/relationship.rb

@@ -3,16 +3,19 @@ module Neo4j
     module Relationship
 
       # Same as Java::OrgNeo4jGraphdb::Relationship#getEndNode
+      # @see http://api.neo4j.org/1.6.1/org/neo4j/graphdb/Relationship.html#getEndNode()
       def _end_node
         get_end_node
       end
 
       # Same as Java::OrgNeo4jGraphdb::Relationship#getStartNode
+      # @see http://api.neo4j.org/1.6.1/org/neo4j/graphdb/Relationship.html#getStartNode()
       def _start_node
         get_start_node
       end
 
       # Same as Java::OrgNeo4jGraphdb::Relationship#getOtherNode
+      # @see http://api.neo4j.org/1.6.1/org/neo4j/graphdb/Relationship.html#getOtherNode()
       def _other_node(node)
         get_other_node(node)
       end
@@ -49,6 +52,7 @@ module Neo4j
       #
       # @param [Neo4j::Node] node the node that we don't want to return
       # @return [Neo4j::Node] the other node wrapper
+      # @see #_other_node
       def other_node(node)
         _other_node(node._java_node).wrapper
       end

data/lib/neo4j-core/version.rb

@@ -1,5 +1,5 @@
 module Neo4j
   module Core
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/lib/neo4j/node.rb

@@ -19,6 +19,7 @@ module Neo4j
     include Neo4j::Core::Equal
     include Neo4j::Core::Node
     include Neo4j::Core::Wrapper
+    include Neo4j::Core::Property::Java # for documentation purpose only
 
     class << self
 

data/lib/neo4j/relationship.rb

@@ -39,6 +39,8 @@ module Neo4j
     include Neo4j::Core::Equal
     include Neo4j::Core::Relationship
     include Neo4j::Core::Wrapper
+    include Neo4j::Core::Property::Java # for documentation purpose only
+
 
     # (see Neo4j::Core::Relationship::ClassMethods#new)
     def initialize(rel_type, start_node, end_node, props={})

data/neo4j-core.gemspec

@@ -27,5 +27,5 @@ It comes included with the Apache Lucene document database.
   s.extra_rdoc_files = %w( README.rdoc )
   s.rdoc_options = ["--quiet", "--title", "Neo4j::Core", "--line-numbers", "--main", "README.rdoc", "--inline-source"]
 
-  s.add_dependency("neo4j-community", "1.7.0.alpha.1")
+  s.add_dependency("neo4j-community", "1.7.M02")
 end

metadata

@@ -2,7 +2,7 @@
 name: neo4j-core
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 0.0.5
 platform: java
 authors: 
   - Andreas Ronge
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-26 00:00:00 Z
+date: 2012-04-01 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: neo4j-community
@@ -20,7 +20,7 @@ dependencies:
       requirements: 
         - - "="
           - !ruby/object:Gem::Version 
-            version: 1.7.0.alpha.1
+            version: 1.7.M02
     type: :runtime
     version_requirements: *id001
 description: |
@@ -53,6 +53,7 @@ files:
   - lib/neo4j-core/to_java.rb
   - lib/neo4j-core/node/node.rb
   - lib/neo4j-core/node/class_methods.rb
+  - lib/neo4j-core/property/java.rb
   - lib/neo4j-core/property/property.rb
   - lib/neo4j-core/equal/equal.rb
   - lib/neo4j-core/traversal/rel_expander.rb