neurallayer.java

一个数据挖掘软件ALPHAMINERR的整个过程的JAVA版源代码

/**
 * This file is generated by BorlandXML.
 */

package com.prudsys.pdm.Adapters.PmmlVersion20;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

/**
 * The NeuralLayer class represents the element "NeuralLayer" with the content
 * model defined as follows:
 * <p>
 * &lt;!ELEMENT NeuralLayer (Extension*,Neuron+)&gt;<br>
 */
public class NeuralLayer extends com.borland.xml.toolkit.XmlObject 
{
	/** xml tag name of this element. */
	public static String _tagName = "NeuralLayer";
	/** Defines a numberOfNeurons attribute */
	public com.borland.xml.toolkit.Attribute numberOfNeurons = new com.borland.xml.toolkit.Attribute("numberOfNeurons", "CDATA", "IMPLIED", "");
	/** Defines a activationFunction attribute */
	public com.borland.xml.toolkit.Attribute activationFunction = new com.borland.xml.toolkit.Attribute("activationFunction", "(threshold | logistic | tanh | identity | softmax)", "IMPLIED", "");
	/** Defines a list of Extension objects. */
	protected ArrayList _objExtension = new ArrayList();
	/** Defines a list of Neuron objects. */
	protected ArrayList _objNeuron = new ArrayList();

	/**
	 * Creates an empty NeuralLayer object
	 */
	public NeuralLayer()
	{
		super();
	}

	/**
	 * Gets the value of "numberOfNeurons" attribute.
	 */
	public String getNumberOfNeurons()
	{
		return numberOfNeurons.getValue();
	}

	/**
	 * Replaces the existing attribute value with a new value.
	 * @param value	New value.
	 */
	public void setNumberOfNeurons(String value_)
	{
		numberOfNeurons.setValue(value_ );
	}

	/**
	 * Gets the value of "activationFunction" attribute.
	 */
	public String getActivationFunction()
	{
		return activationFunction.getValue();
	}

	/**
	 * Replaces the existing attribute value with a new value.
	 * @param value	New value.
	 */
	public void setActivationFunction(String value_)
	{
		activationFunction.setValue(value_ );
	}

	/**
	 * Returns an array of Extension objects. The length of the returned
	 * array is zero if the list of Extension object is empty.
	 */
	public Extension[] getExtension()
	{
		return (Extension[])_objExtension.toArray(new Extension[0]);
	}

	/**
	 * Replaces all existing Extension objects with a new array of
	 * Extension objects.
	 * @param objArray	an array of Extension objects.
	 */
	public void setExtension(Extension[] objArray)
	{
		if( objArray == null || objArray.length == 0 )
			this._objExtension.clear();
		else
		{
			this._objExtension = new ArrayList(Arrays.asList(objArray));
			for( int i=0; i<objArray.length; i++ )
			{
				if( objArray[i] != null )
					objArray[i]._setParent(this);
			}
		}
	}

	/**
	 * Gets the Extension object at the specified index.
	 * @param index	index of the returned object.
	 * @throws IndexOutOfBoundsException	if index is out of range.
	 */
	public Extension getExtension(int index)
	{
		return (Extension)_objExtension.get(index);
	}

	/**
	 * Replaces an existing Extension object at the specified index with
	 * a new Extension object.
	 * @param index	index of replaced object.
	 * @throws IndexOutOfBoundsException	if index is out of range.
	 */
	public void setExtension(int index, Extension obj)
	{
		if( obj == null )
			removeExtension(index);
		else
		{
			_objExtension.set(index, obj);
			obj._setParent(this);
		}
	}

	/**
	 * Returns the number of Extension objects in the list.
	 */
	public int getExtensionCount()
	{
		return _objExtension.size();
	}

	/**
	 * Returns <code>true</code> if there is no Extension object in the list; otherwise,
	 * the method returns <code>false</code>.
	 */
	public boolean isNoExtension()
	{
		return _objExtension.size() == 0;
	}

	/**
	 * Returns a read-only list of Extension objects.
	 */
	public List getExtensionList()
	{
		return Collections.unmodifiableList(_objExtension);
	}

	/**
	 * Adds a new Extension object at the end of the list.
	 * @return <code>true</code> if the new object is added to the list; otherwise,
	 * the method returns <code>false</code>.
	 */
	public boolean addExtension(Extension obj)
	{
		if( obj==null )
			return false;

		obj._setParent(this);
		return _objExtension.add(obj);
	}

	/**
	 * Adds a list of new Extension objects at the end of the list.
	 * @return <code>true</code> if the list was changed; otherwise, the method
	 * returns <code>false</code>.
	 */
	public boolean addExtension(Collection coExtension)
	{
		if( coExtension==null )
			return false;

		java.util.Iterator it = coExtension.iterator();
		while( it.hasNext() )
		{
			Object obj = it.next();
			if( obj != null && obj instanceof com.borland.xml.toolkit.XmlObject )
				((com.borland.xml.toolkit.XmlObject)obj)._setParent(this);
		}
		return _objExtension.addAll(coExtension);
	}

	/**
	 * Removes an existing Extension object at the specified index.
	 * @return	The removed object.
	 */
	public Extension removeExtension(int index)
	{
		return (Extension)_objExtension.remove(index);
	}

	/**
	 * Removes the specified Extension object.
	 * @return <code>true</code> if this list contains the object; otherwise,
	 * the method returns <code>false</code>.
	 */
	public boolean removeExtension(Extension obj)
	{
		return _objExtension.remove(obj);
	}

	/**
	 * Clears all Extension objects from the list.
	 */
	public void clearExtensionList()
	{
		_objExtension.clear();
	}
	/**
	 * Returns an array of Neuron objects. The length of the returned
	 * array is zero if the list of Neuron object is empty.
	 */
	public Neuron[] getNeuron()
	{
		return (Neuron[])_objNeuron.toArray(new Neuron[0]);
	}

	/**
	 * Replaces all existing Neuron objects with a new array of
	 * Neuron objects.
	 * @param objArray	an array of Neuron objects.
	 */
	public void setNeuron(Neuron[] objArray)
	{
		if( objArray == null || objArray.length == 0 )
			this._objNeuron.clear();
		else
		{
			this._objNeuron = new ArrayList(Arrays.asList(objArray));
			for( int i=0; i<objArray.length; i++ )
			{
				if( objArray[i] != null )
					objArray[i]._setParent(this);
			}
		}
	}

	/**
	 * Gets the Neuron object at the specified index.
	 * @param index	index of the returned object.
	 * @throws IndexOutOfBoundsException	if index is out of range.
	 */
	public Neuron getNeuron(int index)
	{
		return (Neuron)_objNeuron.get(index);
	}

	/**
	 * Replaces an existing Neuron object at the specified index with
	 * a new Neuron object.
	 * @param index	index of replaced object.
	 * @throws IndexOutOfBoundsException	if index is out of range.
	 */
	public void setNeuron(int index, Neuron obj)
	{
		if( obj == null )
			removeNeuron(index);
		else
		{
			_objNeuron.set(index, obj);
			obj._setParent(this);
		}
	}

	/**
	 * Returns the number of Neuron objects in the list.
	 */
	public int getNeuronCount()
	{
		return _objNeuron.size();
	}

	/**
	 * Returns <code>true</code> if there is no Neuron object in the list; otherwise,
	 * the method returns <code>false</code>.
	 */
	public boolean isNoNeuron()
	{
		return _objNeuron.size() == 0;
	}

	/**
	 * Returns a read-only list of Neuron objects.
	 */
	public List getNeuronList()
	{
		return Collections.unmodifiableList(_objNeuron);
	}

	/**
	 * Adds a new Neuron object at the end of the list.
	 * @return <code>true</code> if the new object is added to the list; otherwise,
	 * the method returns <code>false</code>.
	 */
	public boolean addNeuron(Neuron obj)
	{
		if( obj==null )
			return false;

		obj._setParent(this);
		return _objNeuron.add(obj);
	}

	/**
	 * Adds a list of new Neuron objects at the end of the list.
	 * @return <code>true</code> if the list was changed; otherwise, the method
	 * returns <code>false</code>.
	 */
	public boolean addNeuron(Collection coNeuron)
	{
		if( coNeuron==null )
			return false;

		java.util.Iterator it = coNeuron.iterator();
		while( it.hasNext() )
		{
			Object obj = it.next();
			if( obj != null && obj instanceof com.borland.xml.toolkit.XmlObject )
				((com.borland.xml.toolkit.XmlObject)obj)._setParent(this);
		}
		return _objNeuron.addAll(coNeuron);
	}

	/**
	 * Removes an existing Neuron object at the specified index.
	 * @return	The removed object.
	 */
	public Neuron removeNeuron(int index)
	{
		return (Neuron)_objNeuron.remove(index);
	}

	/**
	 * Removes the specified Neuron object.
	 * @return <code>true</code> if this list contains the object; otherwise,
	 * the method returns <code>false</code>.
	 */
	public boolean removeNeuron(Neuron obj)
	{
		return _objNeuron.remove(obj);
	}

	/**
	 * Clears all Neuron objects from the list.
	 */
	public void clearNeuronList()
	{
		_objNeuron.clear();
	}

	/**
	 * Marshals this object to an element.
	 */
	public com.borland.xml.toolkit.Element marshal()
	{
		com.borland.xml.toolkit.Element elem = new com.borland.xml.toolkit.Element(get_TagName());
		/** Marshals "numberOfNeurons" attribute */
		elem.addAttribute(numberOfNeurons.marshal());
		/** Marshals "activationFunction" attribute */
		elem.addAttribute(activationFunction.marshal());
		/** Marshals a list of Extension objects to elements */
		Iterator it1 = _objExtension.iterator();
		while( it1.hasNext() )
		{
			Extension obj = (Extension)it1.next();
			if( obj != null )
				elem.addContent(obj.marshal());
		}
		/** Marshals a list of Neuron objects to elements */
		Iterator it2 = _objNeuron.iterator();
		while( it2.hasNext() )
		{
			Neuron obj = (Neuron)it2.next();
			if( obj != null )
				elem.addContent(obj.marshal());
		}

		return elem;
	}

	/**
	 * Unmarshals the specified "NeuralLayer" element back to a NeuralLayer object.
	 */
	public static NeuralLayer unmarshal(com.borland.xml.toolkit.Element elem)
	{
		if( elem == null )
			return null;

		NeuralLayer __objNeuralLayer = new NeuralLayer();
		if( __objNeuralLayer != null ) //found the element?
		{
			/** Unmarshals "numberOfNeurons" attribute */
			__objNeuralLayer.numberOfNeurons.setValue(elem.getAttribute("numberOfNeurons"));
			/** Unmarshals "activationFunction" attribute */
			__objNeuralLayer.activationFunction.setValue(elem.getAttribute("activationFunction"));
		}
		/** Unmarshals a list of "<<_tagName_>>" elements back to Extension objects. */
		Iterator it1 = elem.getChildren(Extension._tagName).iterator();
		while( it1.hasNext() )
			__objNeuralLayer.addExtension(Extension.unmarshal((com.borland.xml.toolkit.Element)it1.next()));
		/** Unmarshals a list of "<<_tagName_>>" elements back to Neuron objects. */
		Iterator it2 = elem.getChildren(Neuron._tagName).iterator();
		while( it2.hasNext() )
			__objNeuralLayer.addNeuron(Neuron.unmarshal((com.borland.xml.toolkit.Element)it2.next()));

		return __objNeuralLayer;
	}

	/**
	 * Validates this object. If you pass <code>true</code> to this method, it
	 * checks for the first error and stops. On the other hand, if you pass
	 * <code>false</code> to this method, it collects all the errors by
	 * visiting every available elements.
	 * @param firstError	<code>true</code> to exit this method when the first error
	 * is found; <code>false</code> to collect all errors.
	 * @return com.borland.xml.toolkit.ErrorList	A list that contains one or more errors.
	 * @see com.borland.xml.toolkit.XmlObject#validate()
	 * @see com.borland.xml.toolkit.XmlObject#isValid()
	 * @see com.borland.xml.toolkit.ErrorList
	 */
	public com.borland.xml.toolkit.ErrorList validate(boolean firstError)
	{
		com.borland.xml.toolkit.ErrorList errors = new com.borland.xml.toolkit.ErrorList();

		/** Extension is zero or more */
		Iterator it1 = _objExtension.iterator();
		while( it1.hasNext() )
		{
			Extension obj = (Extension)it1.next();
			if( obj != null )
			{
				errors.add(obj.validate(firstError));
				if( firstError && errors.size() > 0 )
					return errors;
			}
		}
		/** Neuron is one or more */
		if( _objNeuron.size() == 0 )
		{
			errors.add(new com.borland.xml.toolkit.ElementError(this, Neuron.class));
			if( firstError )
				return errors;
		}
		else
		{
			Iterator it2 = _objNeuron.iterator();
			while( it2.hasNext() )
			{
				Neuron obj = (Neuron)it2.next();
				if( obj != null )
				{
					errors.add(obj.validate(firstError));
					if( firstError && errors.size() > 0 )
						return errors;
				}
			}
		}

		return errors.size()==0 ? null : errors;
	}

	/**
	 * Returns a list containing all child elements. Each element in the list is a subclass
	 * of XmlObject.
	 */
	public java.util.List _getChildren()
	{
		java.util.List children = new java.util.ArrayList();
		/** adds _objExtension */
		if( _objExtension != null && _objExtension.size() > 0 )
			children.add(_objExtension);
		/** adds _objNeuron */
		if( _objNeuron != null && _objNeuron.size() > 0 )
			children.add(_objNeuron);
		return children;
	}


	/**
	 * Gets the tag name of this element.
	 */
	public String get_TagName()
	{
		return _tagName;
	}
}