Source code: com/aendvari/common/model/osm/OsmModelTree.java

   /*
    * OsmModelTree.java
    *
    * Copyright (c) 2001, 2002 Aendvari, Ltd. All Rights Reserved.
    *
    * See the file LICENSE for terms of use.
    *
    */
   
  package com.aendvari.common.model.osm;
  
  import java.util.*;
  import java.io.*;
  
  import java.lang.reflect.*;
  
  import com.aendvari.common.util.ResourceLoader;
  
  import com.aendvari.common.model.ModelNode;
  import com.aendvari.common.model.ModelTree;
  import com.aendvari.common.model.ModelException;
  import com.aendvari.common.model.ModelParserException;
  
  import com.aendvari.common.osm.Osm;
  import com.aendvari.common.osm.OsmReader;
  import com.aendvari.common.osm.OsmNode;
  import com.aendvari.common.osm.QueryOsmPath;
  import com.aendvari.common.osm.SimpleOsmPath;
  
  
  /**
   * <p>An OSM implementation of the {@link ModelNode} interface.</p>
   *
   * @author  Scott Milne
   *
   */
  
  public class OsmModelTree implements ModelTree
  {
    /* Variables */
  
    /** The OSM that represents the model tree */
    protected Osm modelTreeOsm;
  
  
    /* Constructors. */
  
  
    /**
     * Constructs an <code>OsmModelTree</code> instance.
     *
     */
  
    public OsmModelTree()
    {
      // create modelTreeOsm hierarchy
      modelTreeOsm = new Osm();
    }
  
    /**
     * Constructs an <code>OsmModelNode</code> instance wrapping the supplied {@link Osm}.
     *
     * @param    setModelTree        The {@link Osm} to wrap.
     *
     */
  
    public OsmModelTree( Osm setModelTree )
    {
      modelTreeOsm = setModelTree;
    }
  
  
    /* Accessors. */
  
  
    /**
     * Sets the internal {@link Osm} object wrapped by this {@link ModelTree}.
     *
     * @param    setModelTree        The {@link Osm} to wrap.
     *
     */
  
    public void setModelTree( Osm setModelTree )
    {
      modelTreeOsm = setModelTree;
    }
  
    /**
     * Returns the internal {@link Osm} object wrapped by this {@link ModelTree}.
     *
     * @return                  The {@link Osm} wrapped by this {@link ModelTree}.
     *
     */
  
    public Osm getModelTree()
    {
      return modelTreeOsm;
    }
  
   /**
    * Creates a new {@link ModelTree} object.
    *
    * @return                  A new {@link ModelTree} object.
    *
    */
 
   public ModelTree createTree()
   {
     return new OsmModelTree();
   }
 
   /**
    * Returns the {@link ModelNode} of the OSM model space.
    *
    * @return                  A {@link ModelNode} representing the root node of the {@link Osm}.
    *
    */
 
   public ModelNode getRootNode()
   {
     return new OsmModelNode(modelTreeOsm);
   }
 
   /**
    * Creates a {@link ModelNode} object from an {@link OsmNode}
    *
    * @param    osmNode            The {@link OsmNode}.
    *
    * @return                  A new {@link ModelNode} object.
    *
    */
 
   public ModelNode createNode(OsmNode osmNode)
   {
     return new OsmModelNode(osmNode);
   }
 
   /**
    * Creates a {@link ModelNode} object.
    *
    * @param    name            The node's name.
    *
    * @return                  A new {@link ModelNode} object.
    *
    */
 
   public ModelNode createNode(String name)
   {
     // create a new node for the message
     OsmNode osmNode = modelTreeOsm.createNode(name);
 
     return new OsmModelNode(osmNode);
   }
 
   /**
    * Creates a {@link ModelNode} object with the supplied value.
    *
    * @param    name            The node's name.
    * @param    value            The node's value.
    *
    * @return                  A new {@link ModelNode} object.
    *
    */
 
   public ModelNode createNode(String name, String value)
   {
     // create a new node for the message
     OsmNode osmNode = modelTreeOsm.createNode(name, value);
 
     // set the value in case it was created
     osmNode.setNodeValue(value);
 
     // return the new node
     return new OsmModelNode(osmNode);
   }
 
   /**
    * Returns the {@link ModelNode} using the path provided.
    *
    * @param    node            The starting position for the search.
    * @param    path            The query expression.
    *
    * @return                  A {@link ModelNode} using the path provided.
    *
    * @exception  ModelException        The search could not be performed.
    *
    */
 
   public ModelNode getNode( ModelNode node, String path ) throws ModelException
   {
     // transform the given model node into an OSM node
     OsmNode parentOsmNode = ((OsmModelNode)node).getOsmNode();
 
     // get the node for the messages
     OsmNode osmNode = QueryOsmPath.selectNode(parentOsmNode, path);
 
     // return node, if found
     if (osmNode != null)
       return new OsmModelNode(osmNode);
     else
       return null;
   }
 
   /**
    * Returns a <code>List</code> of {@link ModelNode}'s using the path provided.
    *
    * @param    node            The starting position for the search.
    * @param    path            The query expression.
    *
    * @return                  A <code>List</code> of {@link ModelNode}'s using the path provided.
    *
    * @exception  ModelException        The search could not be performed.
    *
    */
 
   public List getNodes( ModelNode node, String path ) throws ModelException
   {
     // transform the given model node into an OSM node
     OsmNode parentOsmNode = ((OsmModelNode)node).getOsmNode();
 
     // get the node for the messages
     Collection osmNodes = QueryOsmPath.selectNodes(parentOsmNode, path);
     Iterator osmIterator = osmNodes.iterator();
 
     // convert to collection of OsmModelNode's
     ArrayList nodes = new ArrayList();
 
     while (osmIterator.hasNext())
     {
       nodes.add( new OsmModelNode((OsmNode)osmIterator.next()) );
     }
 
     return nodes;
   }
 
 
   /**
    * Replaces the current {@link ModelTree} with data prodivided by the file.
    *
    * @param    xmlFile            A path to the XML file.
    *
    * @exception  ModelParserException    The file could not be parsed.
    *
    */
 
   public void loadFromFile( String xmlFile ) throws ModelParserException
   {
     try
     {
       FileInputStream in = new FileInputStream(xmlFile);
 
       InputStreamReader inputReader = new InputStreamReader(in);
 
       BufferedReader bufferedReader = new BufferedReader(inputReader);
 
       modelTreeOsm = OsmReader.read(bufferedReader);
     }
     catch (Exception exception)
     {
       throw new ModelParserException(exception);
     }
   }
 
   /**
    * Replaces the current {@link ModelTree} with the given XML stream.
    *
    * @param    xmlStream          A {@link java.io.InputStream} instance.
    *
    * @exception  ModelParserException    The stream could not be parsed.
    *
    */
 
   public void loadFromStream( InputStream xmlStream ) throws ModelParserException
   {
     try
     {
       InputStreamReader inputReader = new InputStreamReader(xmlStream);
 
       BufferedReader bufferedReader = new BufferedReader(inputReader);
 
       modelTreeOsm = OsmReader.read(bufferedReader);
     }
     catch (Exception exception)
     {
       throw new ModelParserException(exception);
     }
   }
 }