christophedelory.betty.xml
Class ModelDetails

java.lang.Object
  christophedelory.betty.xml.Child
      christophedelory.betty.xml.IdDetails
          christophedelory.betty.xml.ModelDetails

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BetModelDetails, RankModelDetails, ScoreModelDetails

public class ModelDetails
extends IdDetails

The base XML definition of a processing model.

Version:

$Revision$

Author:

Christophe Delory

See Also:

Serialized Form

Constructor Summary

ModelDetails(String defaultModel)
Builds a new processing model definition, based on the input parameter.

Method Summary

void	accept(XmlVisitor visitor) Accepts the specified XML visitor.
void	addProperty(PropertyDetails property) Adds the specified property to the list of parameters attached to this processing model.
PropertyDetails	findPropertyById(String id) Searches for a property in this XML element that matches the input parameter.
List<PropertyDetails>	getProperties() Returns the list of parameters attached to this processing model.

Methods inherited from class christophedelory.betty.xml.IdDetails

addDescription, addLink, findDescriptionByLocale, findLinkByLocale, getDescriptions, getId, getLinks, setId

Methods inherited from class christophedelory.betty.xml.Child

getParent, getRoot, getRoot, getVersion, setParent, setVersion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModelDetails

public ModelDetails(String defaultModel)

Builds a new processing model definition, based on the input parameter.

Parameters:

defaultModel - the default identifier of this processing model. Shall not be null.

Throws:

NullPointerException - if defaultModel is null.

Method Detail

getProperties

public List<PropertyDetails> getProperties()

Returns the list of parameters attached to this processing model.

Returns:

a list of properties. May be empty but not null.

See Also:

addProperty(PropertyDetails)

addProperty

public void addProperty(PropertyDetails property)

Adds the specified property to the list of parameters attached to this processing model.

Parameters:

property - a property. Shall not be null.

Throws:

NullPointerException - if property is null.

See Also:

getProperties()

findPropertyById

public PropertyDetails findPropertyById(String id)

Searches for a property in this XML element that matches the input parameter.

Parameters:

id - a property identifier. Must not be null.

Returns:

an XML representation of the property, or null if none was found.

Throws:

NullPointerException - if id is null.

accept

public void accept(XmlVisitor visitor)
            throws Exception

Description copied from class: IdDetails

Accepts the specified XML visitor.

Overrides:

accept in class IdDetails

Parameters:

visitor - a visitor. Shall not be null.

Throws:

NullPointerException - if visitor is null.

Exception - if any error occurs during the visit.