org.concord.biologica.engine
Class Trait

java.lang.Object
  |
  +--org.xml.sax.HandlerBase
        |
        +--org.concord.biologica.engine.EngineObject
              |
              +--org.concord.biologica.engine.Trait

All Implemented Interfaces:

org.xml.sax.DocumentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler, java.io.Serializable

public final class Trait

extends EngineObject

implements java.io.Serializable

This class represents a trait of a species.

A trait is defined as a specific property of an organism. The term "trait" is a synonym for "characteristic" and "character".

Examples of traits are "flower color", "horn type", "tail type", etc. For each trait, there are a set of characteristics for that trait - "purple" and "white" for flower color, "no horns" and "2 horns" for horn type, etc.

An object of this class will generate the following property change events:

• EngineProp.CHARACTERISTIC_ADDED - a characteristic was added to trait
• EngineProp.CHARACTERISTIC_REMOVED - a characteristic was removed from trait
• EngineProp.DELETED - object has been deleted
• EngineProp.ID - object's id has changed
• EngineProp.LOCKED_STATE - the locked state of the object has changed
• EngineProp.NAME - name of this trait has changed

Version:

$Revision: 1.1.1.1 $ $Date: 2001/04/28 00:39:15 $

Author:

$Author: ed $

See Also:

EngineProp.CHARACTERISTIC_ADDED, EngineProp.CHARACTERISTIC_REMOVED, EngineProp.DELETED, EngineProp.ID, EngineProp.LOCKED_STATE, EngineProp.NAME, PropertyChangeListener, Serialized Form

Fields inherited from class org.concord.biologica.engine.EngineObject

AUTOMATIC_LOCKED, AUTOMATIC_LOCKED_STRING, changes, deleted, FALSE, id, lockedState, MANUAL_AND_AUTOMATIC_LOCKED, MANUAL_AND_AUTOMATIC_LOCKED_STRING, MANUAL_LOCKED, MANUAL_LOCKED_STRING, NULL_ID, TRUE, UNLOCKED, UNLOCKED_STRING, xmlElementContext

Constructor Summary

Trait(Species aSpecies, java.lang.String aName)
Creates a new trait with the given name.

Trait(Species aSpecies, java.lang.String anElementName, int anElementID, com.sun.xml.parser.Parser anXMLParser, ImportContext importContext)
Create a new trait and start handling XML parsing events to set the properties of this object.

Method Summary

void	characters(char[] ch, int start, int length) Receive notification of character data.
void	delete() Delete this object, notifying parent objects and deleting any child objects.
void	delete(boolean notifyChange)
void	endElement(java.lang.String anElementName) Handle notification that the parsing of the given element has ended.
java.util.Enumeration	getCharacteristics() Returns an enumeration over the vector of characteristics in this trait.
java.lang.String	getName() Return the name of this trait.
int	getNumberOfCharacteristics() Return the number of characteristics of this trait.
Species	getSpecies() Return the species of this trait.
World	getWorld() Get the world containing this object.
void	ignorableWhitespace(char[] ch, int start, int length) Receive notification of ignorable white space character data.
boolean	isShowAsTextInOrganismView() Get whether this trait should be shown as text in the organism view.
void	setAutomaticLocked(boolean automaticLocked) Set or unset the automatic locked state of this object, leaving other components of the locked state untouched.
void	setLockedState(int aLockedState) Set the locked state of the object, recursively setting the lock state of children objects.
void	setManualLocked(boolean manualLocked) Set or unset the manual locked state of this object, leaving other components of the locked state untouched.
void	setName(java.lang.String aName) Set the name of this trait.
void	setShowAsTextInOrganismView(boolean TorF) Set whether this trait should be shown as text in the organism view.
void	startElement(java.lang.String anElementName, org.xml.sax.AttributeList amap) Handle notification that the parser has hit the start of a new element with the given name and attributes.
java.lang.String	toString() Return a string representation of this object, usually the object's name.
void	writeToStream(java.io.PrintWriter stream) Writes this object to the given stream in XML format.

Methods inherited from class org.concord.biologica.engine.EngineObject

addPropertyChangeListener, getID, getLockedState, getLockedStateAsString, isAutomaticLocked, isDeleted, isLocked, isManualLocked, notifySelected, release, removePropertyChangeListener, setID, setLockedStateAsString

Methods inherited from class org.xml.sax.HandlerBase

endDocument, error, fatalError, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, startDocument, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

Trait

public Trait(Species aSpecies,
             java.lang.String aName)

Creates a new trait with the given name.

Parameters:

aSpecies - Species - the species containing this trait, may not be null

aName - String - name of this trait, may not be null

Throws:

java.lang.IllegalArgumentException - - input argument(s) illegal

Trait

public Trait(Species aSpecies,
             java.lang.String anElementName,
             int anElementID,
             com.sun.xml.parser.Parser anXMLParser,
             ImportContext importContext)

Create a new trait and start handling XML parsing events to set the properties of this object.

Parameters:

aSpecies - Species - the enclosing species for this new trait

anElementName - String - the element name

anElementID - int - the element id

anXMLParser - com.sun.xml.parser.Parser - the element parser

importContext - ImportContext - import context for mapping ids from file to this world

Throws:

java.lang.IllegalArgumentException - - input arguments illegal

Method Detail

startElement

public void startElement(java.lang.String anElementName,
                         org.xml.sax.AttributeList amap)
                  throws org.xml.sax.SAXException

Handle notification that the parser has hit the start of a new element with the given name and attributes.

For internal elements (elements that are non-EngineObject instance variables of this object), call xmlElementContext.startElement() and xmlElementContext will receive the remaining element notifications. For external elements (elements that are EngineObject instance variables of this object), create an object of the appropriate class and that object will receive the remaining element notifications.

Overrides:

startElement in class org.xml.sax.HandlerBase

Parameters:

anElementName - String - name of element

amap - AttributeList - an attribute list

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

Receive notification of character data.

Overrides:

characters in class org.xml.sax.HandlerBase

Parameters:

ch - char[] - characters

start - int - start of string

length - int - length of string

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws org.xml.sax.SAXException

Receive notification of ignorable white space character data.

Overrides:

ignorableWhitespace in class org.xml.sax.HandlerBase

Parameters:

ch - char[] - characters

start - int - start of string

length - int - length of string

endElement

public void endElement(java.lang.String anElementName)
                throws org.xml.sax.SAXException

Handle notification that the parsing of the given element has ended.

Overrides:

endElement in class org.xml.sax.HandlerBase

Parameters:

anElementName - String - the element name

delete

public void delete()

Delete this object, notifying parent objects and deleting any child objects.

When this method is called, a property change event is generated for the property named EngineProp.DELETED.

Overrides:

delete in class EngineObject

delete

public void delete(boolean notifyChange)

toString

public java.lang.String toString()

Return a string representation of this object, usually the object's name.

Overrides:

toString in class EngineObject

Returns:

String - string representation of object

setAutomaticLocked

public void setAutomaticLocked(boolean automaticLocked)

Set or unset the automatic locked state of this object, leaving other components of the locked state untouched. Recursively sets the automatic locked state of children of this object.

When this property is changed, a property change event is fired for the property named EngineProp.LOCKED_STATE.

Overrides:

setAutomaticLocked in class EngineObject

Parameters:

automaticLocked - boolean - object should be automatic locked (true) or not (false)

setManualLocked

public void setManualLocked(boolean manualLocked)

Set or unset the manual locked state of this object, leaving other components of the locked state untouched. Recursively sets the manual locked state of children of this object.

When this property is changed, a property change event is fired for the property named EngineProp.LOCKED_STATE.

Overrides:

setManualLocked in class EngineObject

Parameters:

manualLocked - boolean - object should be manually locked (true) or not (false)

setLockedState

public void setLockedState(int aLockedState)

Set the locked state of the object, recursively setting the lock state of children objects.

When this property is changed, a property change event is fired for the property named EngineProp.LOCKED_STATE.

Overrides:

setLockedState in class EngineObject

Parameters:

aLockedState - int - new locked state of this object

Throws:

java.lang.IllegalArgumentException - - new locked state invalid

getSpecies

public Species getSpecies()

Return the species of this trait.

Returns:

Species - species of this trait, never null

getWorld

public World getWorld()

Get the world containing this object.

Overrides:

getWorld in class EngineObject

Returns:

World - the world containing this object, never null.

getName

public java.lang.String getName()

Return the name of this trait.

Returns:

String - name of this trait, may not be null

setName

public void setName(java.lang.String aName)

Set the name of this trait.

When this method is successful, a property change event is fired for the property named EngineProp.NAME.

Parameters:

aName - String - the new name of this trait, may not be null

Throws:

java.lang.IllegalArgumentException - - input argument illegal

isShowAsTextInOrganismView

public boolean isShowAsTextInOrganismView()

Get whether this trait should be shown as text in the organism view.

Returns:

boolean - whether this trait should be shown as text in organism view.

setShowAsTextInOrganismView

public void setShowAsTextInOrganismView(boolean TorF)

Set whether this trait should be shown as text in the organism view.

Parameters:

TorF - boolean - shown as text (true) or not shown as text (false)

getCharacteristics

public java.util.Enumeration getCharacteristics()

Returns an enumeration over the vector of characteristics in this trait.

Returns:

Enumeration - an enumeration over the characteristics in this trait

getNumberOfCharacteristics

public int getNumberOfCharacteristics()

Return the number of characteristics of this trait.

Returns:

int - the number of characteristics of this trait

writeToStream

public void writeToStream(java.io.PrintWriter stream)
                   throws java.io.IOException

Writes this object to the given stream in XML format. Usually this method is used to write the object to a file for saving it, but that is potentially not the only use.

We could supply a default implementation that knows how to write the id value. But that convenience is not chosen because it's never correct to use just this implementation of these methods, so I'd rather have a compilation fail if a derived class fails to implement this method.

The inverse of this method is a constructor that takes a org.xml.sax.Parser argument and other arguments.

Overrides:

writeToStream in class EngineObject

Parameters:

stream - PrintWriter - print stream

Throws:

java.lang.IllegalArgumentException - - input arguments illegal

java.io.IOException - - an IO error occurred in java libraries