gov.sandia.cognition.framework
Class DefaultCogxel

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.framework.DefaultCogxel
All Implemented Interfaces:
Cogxel, CloneableSerializable, Serializable, Cloneable
Direct Known Subclasses:
BooleanActivatableCogxel

public class DefaultCogxel
extends AbstractCloneableSerializable
implements Cogxel

The DefaultCogxel provides a default implementation of the Cogxel interface that just stores the necessary peices of information: the SemanticIdentifier and its activation.

Since:
1.0
Author:
Justin Basilico
See Also:
Serialized Form

Constructor Summary
DefaultCogxel(DefaultCogxel other)
          Creates a copy of a given Cogxel.
DefaultCogxel(SemanticIdentifier identifier)
          Creates a new instance of Cogxel.
DefaultCogxel(SemanticIdentifier identifier, double activation)
          Creates a new instance of Cogxel.
 
Method Summary
 DefaultCogxel clone()
          This makes public the clone method on the Object class and removes the exception that it throws.
 double getActivation()
          Gets the current activation level of the Cogxel
 SemanticIdentifier getSemanticIdentifier()
          Gets the SemanticIdentifier for the Cogxel.
 SemanticLabel getSemanticLabel()
          Gets the SemanticLabel for the Cogxel.
 void setActivation(double activation)
          Sets the activation level of the Cogxel.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultCogxel

public DefaultCogxel(SemanticIdentifier identifier)
Creates a new instance of Cogxel. The default activation is 0.0.

Parameters:
identifier - The SemanticIdentifier for the Cogxel.
Throws:
IllegalArgumentException - If an invalid identifier is given.

DefaultCogxel

public DefaultCogxel(SemanticIdentifier identifier,
                     double activation)
Creates a new instance of Cogxel.

Parameters:
identifier - The SemanticIdentifier for the Cogxel.
activation - The initial activation for the Cogxel.
Throws:
IllegalArgumentException - If an invalid identifier is given.

DefaultCogxel

public DefaultCogxel(DefaultCogxel other)
Creates a copy of a given Cogxel.

Parameters:
other - The Cogxel to copy.
Method Detail

clone

public DefaultCogxel clone()
This makes public the clone method on the Object class and removes the exception that it throws. Its default behavior is to automatically create a clone of the exact type of object that the clone is called on and to copy all primitives but to keep all references, which means it is a shallow copy. Extensions of this class may want to override this method (but call super.clone() to implement a "smart copy". That is, to target the most common use case for creating a copy of the object. Because of the default behavior being a shallow copy, extending classes only need to handle fields that need to have a deeper copy (or those that need to be reset). Some of the methods in ObjectUtil may be helpful in implementing a custom clone method. Note: The contract of this method is that you must use super.clone() as the basis for your implementation.

Specified by:
clone in interface Cogxel
Specified by:
clone in interface CloneableSerializable
Overrides:
clone in class AbstractCloneableSerializable
Returns:
A clone of this object.

getSemanticIdentifier

public SemanticIdentifier getSemanticIdentifier()
Gets the SemanticIdentifier for the Cogxel.

Specified by:
getSemanticIdentifier in interface Cogxel
Returns:
The SemanticIdentifier for the Cogxel.

getSemanticLabel

public SemanticLabel getSemanticLabel()
Gets the SemanticLabel for the Cogxel.

Specified by:
getSemanticLabel in interface Cogxel
Returns:
The SemanticLabel for the Cogxel.

getActivation

public double getActivation()
Gets the current activation level of the Cogxel

Specified by:
getActivation in interface Cogxel
Returns:
The current activation level.

setActivation

public void setActivation(double activation)
Sets the activation level of the Cogxel.

Specified by:
setActivation in interface Cogxel
Parameters:
activation - The new activation level.