Most of a method to delete a way and all its nodes - but I'm waiting on splitting...

[rails.git] / app / models / node.rb

diff --git a/app/models/node.rb b/app/models/node.rb
index 69ce5d6821618929062a58d338f9d29d54cf5a03..37143ff00c5883a70daeed8717da9cbe25594776 100644 (file)
--- a/app/models/node.rb
+++ b/app/models/node.rb
@@ -1,3 +1,5 @@
+# The node model represents a current existing node, that is, the latest version. Use OldNode for historical nodes.
+
 class Node < GeoRecord
   require 'xml/libxml'
 
@@ -9,18 +11,49 @@ class Node < GeoRecord
   validate :validate_position
 
   has_many :old_nodes, :foreign_key => :id
+  has_many :way_nodes
   belongs_to :user
  
+  # Sanity check the latitude and longitude and add an error if it's broken
   def validate_position
     errors.add_to_base("Node is not in the world") unless in_world?
   end
 
+  # Is this node withing -90 > latitude > 90 and -180 > longitude > 180>
+  # * returns true/false
   def in_world?
     return false if self.lat < -90 or self.lat > 90
     return false if self.lon < -180 or self.lon > 180
     return true
   end
 
+  #
+  # Search for nodes matching tags within bounding_box
+  #
+  # Also adheres to limitations such as within max_number_of_nodes
+  #
+  def self.search(bounding_box, tags = {})
+    min_lon, min_lat, max_lon, max_lat = *bounding_box
+    # @fixme a bit of a hack to search for only visible nodes
+    # couldn't think of another to add to tags condition
+    #conditions_hash = tags.merge({ 'visible' => 1 })
+  
+    # using named placeholders http://www.robbyonrails.com/articles/2005/10/21/using-named-placeholders-in-ruby
+    #keys = []
+    #values = {}
+
+    #conditions_hash.each do |key,value|
+    #  keys <<  "#{key} = :#{key}"
+    #  values[key.to_sym] = value
+    #end 
+    #conditions = keys.join(' AND ')
+ 
+    find_by_area(min_lat, min_lon, max_lat, max_lon,
+                    :conditions => 'visible = 1',
+                    :limit => APP_CONFIG['max_number_of_nodes']+1)  
+  end
+
+  # Read in xml as text and return it's Node object representation
   def self.from_xml(xml, create=false)
     begin
       p = XML::Parser.new
@@ -66,6 +99,7 @@ class Node < GeoRecord
     return node
   end
 
+  # Save this node with the appropriate OldNode object to represent it's history.
   def save_with_history!
     Node.transaction do
       self.timestamp = Time.now
@@ -75,12 +109,14 @@ class Node < GeoRecord
     end
   end
 
+  # Turn this Node in to a complete OSM XML object with <osm> wrapper
   def to_xml
     doc = OSM::API.new.get_xml_doc
     doc.root << to_xml_node()
     return doc
   end
 
+  # Turn this Node in to an XML Node without the <osm> wrapper.
   def to_xml_node(user_display_name_cache = nil)
     el1 = XML::Node.new 'node'
     el1['id'] = self.id.to_s
@@ -111,6 +147,7 @@ class Node < GeoRecord
     return el1
   end
 
+  # Return the node's tags as a Hash of keys and their values
   def tags_as_hash
     hash = {}
     Tags.split(self.tags) do |k,v|
@@ -118,5 +155,4 @@ class Node < GeoRecord
     end
     hash
   end
-
 end