com.googlecode.sarasvati.load.NodeFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sarasvati-core Show documentation

The newest version!

/*
    This file is part of Sarasvati.

    Sarasvati is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as
    published by the Free Software Foundation, either version 3 of the
    License, or (at your option) any later version.

    Sarasvati is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with Sarasvati.  If not, see .

    Copyright 2008 Paul Lorenz
*/
package com.googlecode.sarasvati.load;

import java.util.Map;

import com.googlecode.sarasvati.CustomNode;
import com.googlecode.sarasvati.Node;

public interface NodeFactory
{
  /**
   * Creates a new node of the given type
   * @return The new node
   *
   * @throws SarasvatiLoadException If a node of the given type cannot be instantiated
   */
  Node newNode (String type) throws SarasvatiLoadException;

  /**
   * Loads the custom data into the node. Returns a map of the data loaded, keyed
   * by bean property name. So if the the node has a property foo, which in turn
   * has a property bar, which was set to 1, then the map will contain an entry
   *
   *    *   foo.bar=1
   * 
   *
   * This may be used to store the data for nodes of type {@link CustomNode}.
   *
   * @param node The node to set the data in
   * @param custom The custom data from the XML file
   *
   * @return A map of bean properties set. This may be used
   *         if the node is a {@link CustomNode}
   *
   *
   * @throws SarasvatiLoadException If custom data is incorrect.
   */
  Map loadCustom (Node node, Object custom) throws SarasvatiLoadException;
}