org.biojava.bio
Class AnnotationRenamer

java.lang.Object
  |
  +--org.biojava.utils.AbstractChangeable
        |
        +--org.biojava.bio.AbstractAnnotation
              |
              +--org.biojava.bio.AnnotationRenamer

All Implemented Interfaces:

Annotation, Changeable, java.io.Serializable

public class AnnotationRenamer

extends AbstractAnnotation

AnnotationRenamer remaps the keys of an Annotation to new keys specified by a TagMapper. This will rename properties, but not alter their values.

Since:

1.3

Author:

Matthew Pocock, Keith James (docs)

See Also:

Serialized Form

For advanced users:

For writing light-weigth adaptors to project one type of Annotation to another using a TagMapper.

Field Summary

Fields inherited from interface org.biojava.bio.Annotation

EMPTY_ANNOTATION, PROPERTY

Constructor Summary

AnnotationRenamer(Annotation wrapped, TagMapper mapper)
Creates a new AnnotationRenamer using the specified TagMapper to remap its keys.

Method Summary

TagMapper	getMapper() getMapper returns the TagMapper being used to remap the Annotation.
java.util.Map	getProperties() getProperties returns the mapped contents of the underlying Annotation as a Map.
Annotation	getWrapped() getWrapped returns the Annotation being remapped.
boolean	propertiesAllocated() propertiesAllocated Javadoc FIXME - this overrides a protected method and I'm not sure why (KJ).

Methods inherited from class org.biojava.bio.AbstractAnnotation

asMap, containsProperty, equals, getProperty, hashCode, keys, removeProperty, setProperty, toString

Methods inherited from class org.biojava.utils.AbstractChangeable

addChangeListener, addChangeListener, generateChangeSupport, getChangeSupport, hasListeners, isUnchanging, removeChangeListener, removeChangeListener

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.biojava.utils.Changeable

addChangeListener, addChangeListener, isUnchanging, removeChangeListener, removeChangeListener

Constructor Detail

AnnotationRenamer

public AnnotationRenamer(Annotation wrapped,
                         TagMapper mapper)

Creates a new AnnotationRenamer using the specified TagMapper to remap its keys.

Parameters:

wrapped - an Annotation.

mapper - a TagMapper.

Method Detail

getWrapped

public Annotation getWrapped()

getWrapped returns the Annotation being remapped.

Returns:

an Annotation.

getMapper

public TagMapper getMapper()

getMapper returns the TagMapper being used to remap the Annotation.

Returns:

a TagMapper.

getProperties

public java.util.Map getProperties()

getProperties returns the mapped contents of the underlying Annotation as a Map.

Specified by:

getProperties in class AbstractAnnotation

Returns:

a Map.

propertiesAllocated

public boolean propertiesAllocated()

propertiesAllocated Javadoc FIXME - this overrides a protected method and I'm not sure why (KJ).

Specified by:

propertiesAllocated in class AbstractAnnotation

Returns:

a boolean.