edu.ucla.sspace.basis

Class AbstractBasisMapping<T,K>

java.lang.Object

edu.ucla.sspace.basis.AbstractBasisMapping<T,K>

All Implemented Interfaces:

BasisMapping<T,K>, Serializable

Direct Known Subclasses:

RelationBasedBasisMapping, StringBasisMapping, WordBasedBasisMapping, WordBasisMapping, WordOrderBasisMapping

public abstract class AbstractBasisMapping<T,K>
extends Object
implements BasisMapping<T,K>, Serializable

An abstract base class for BasisMappings that implements most of the required functionality. For any requested feature, the currently mapped dimension is returned upon request, or a new dimension is generated if the BasisMapping is not in read only mode.

All access to this BasisMapping is thread safe.

Author:

Keith Stevens

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractBasisMapping() Creates a new AbstractBasisMapping.

Method Summary

Methods

Modifier and Type	Method and Description
K	getDimensionDescription(int dimension) Returns a description of the specified dimension.
protected int	getDimensionInternal(K key) Returns an integer corresponding to key.
protected Map<K,Integer>	getMapping() Returns the internal mapping from keys to indices.
boolean	isReadOnly() Returns true if the BasisMapping is read only, false otherwise.
Set<K>	keySet() Returns the set of keys known by this BasisMapping
int	numDimensions() Returns the number of dimensions currently represented in this basis mapping.
void	setReadOnly(boolean readOnly) Sets the read only state of the basis mapping.

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.ucla.sspace.basis.BasisMapping

getDimension

Constructor Detail

AbstractBasisMapping

public AbstractBasisMapping()

Creates a new AbstractBasisMapping.

Method Detail

getDimensionDescription

public K getDimensionDescription(int dimension)

Returns a description of the specified dimension.

Specified by:

getDimensionDescription in interface BasisMapping<T,K>

Parameters:

dimension - a dimension number

Returns:

a description of the dimension

keySet

public Set<K> keySet()

Returns the set of keys known by this BasisMapping

Specified by:

keySet in interface BasisMapping<T,K>

getDimensionInternal

protected int getDimensionInternal(K key)

Returns an integer corresponding to key. If in read only mode, -1 is returned for unseen keys. Otherwise, unseen keys are assigned a new dimension.

getMapping

protected Map<K,Integer> getMapping()

Returns the internal mapping from keys to indices.

numDimensions

public int numDimensions()

Returns the number of dimensions currently represented in this basis mapping.

Specified by:

numDimensions in interface BasisMapping<T,K>

setReadOnly

public void setReadOnly(boolean readOnly)

Sets the read only state of the basis mapping. This is intended for when the basis mapping is needed to map to a known set of values, and any unknown values are left unmapped.

Specified by:

setReadOnly in interface BasisMapping<T,K>

isReadOnly

public boolean isReadOnly()

Returns true if the BasisMapping is read only, false otherwise.

Specified by:

isReadOnly in interface BasisMapping<T,K>