gov.sandia.cognition.framework.learning.converter

Class AbstractCogxelConverter<DataType>

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.framework.learning.converter.AbstractCogxelConverter<DataType>

Type Parameters:

DataType - Type of data to convert to/from Cogxels

All Implemented Interfaces:

CogxelConverter<DataType>, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

AbstractCogxelPairConverter, CogxelBooleanConverter

public abstract class AbstractCogxelConverter<DataType>
extends AbstractCloneableSerializable
implements CogxelConverter<DataType>

Partial implementation of CogxelConverter

Since:

3.0

Author:

Kevin R. Dixon

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected SemanticIdentifierMap	semanticIdentifierMap The SemanticIdentifierMap for the converter.

Constructor Summary

Constructors

Constructor and Description
AbstractCogxelConverter() Default constructor
AbstractCogxelConverter(SemanticIdentifierMap semanticIdentifierMap) Creates a new instance of AbstractCogxelConverter

Method Summary

Modifier and Type	Method and Description
protected void	buildIdentifierCache() Rebuilds the cache of SemanticIdentifier objects.
CogxelConverter<DataType>	clone() This makes public the clone method on the Object class and removes the exception that it throws.
SemanticIdentifierMap	getSemanticIdentifierMap() Gets the SemanticIdentifierMap used by this converter.
void	setSemanticIdentifierMap(SemanticIdentifierMap semanticIdentifierMap) Sets the SemanticIdentifierMap that the converter is to use.

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.sandia.cognition.framework.learning.converter.CogxelConverter

fromCogxels, toCogxels

Field Detail

semanticIdentifierMap

protected SemanticIdentifierMap semanticIdentifierMap

The SemanticIdentifierMap for the converter.

Constructor Detail

AbstractCogxelConverter

public AbstractCogxelConverter()

Default constructor

AbstractCogxelConverter

public AbstractCogxelConverter(SemanticIdentifierMap semanticIdentifierMap)

Creates a new instance of AbstractCogxelConverter

Parameters:

semanticIdentifierMap - The SemanticIdentifierMap for the converter.

Method Detail

clone

public CogxelConverter<DataType> clone()

Description copied from class: AbstractCloneableSerializable

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 CogxelConverter<DataType>

Specified by:

clone in interface CloneableSerializable

Overrides:

clone in class AbstractCloneableSerializable

Returns:

A clone of this object.

buildIdentifierCache

protected void buildIdentifierCache()

Rebuilds the cache of SemanticIdentifier objects. Should only need to be called after the SemanticIdentifierMap is changed.

Since:

3.0

getSemanticIdentifierMap

public SemanticIdentifierMap getSemanticIdentifierMap()

Description copied from interface: CogxelConverter

Gets the SemanticIdentifierMap used by this converter.

Specified by:

getSemanticIdentifierMap in interface CogxelConverter<DataType>

Returns:

The SemanticIdentifierMap used by this converter.

setSemanticIdentifierMap

public void setSemanticIdentifierMap(SemanticIdentifierMap semanticIdentifierMap)

Description copied from interface: CogxelConverter

Sets the SemanticIdentifierMap that the converter is to use.

Specified by:

setSemanticIdentifierMap in interface CogxelConverter<DataType>

Parameters:

semanticIdentifierMap - The SemanticIdentifierMap the converter is to use.