ooc
Class LinkedTagInstance

java.lang.Object
  extended byooc.LinkedTagInstance
All Implemented Interfaces:
Dependencies
Direct Known Subclasses:
AbstractDataSource, AbstractEdgeType, AbstractFamilyGroup, AbstractInparalogous, AbstractSequenceData, AbstractStringNodeConverter, AbstractTreeParser, Compute, PreferredTree, TreeStructureParserLeafList, TreeStructureParserSchreiber

public abstract class LinkedTagInstance
extends java.lang.Object
implements Dependencies

This class contains mehtods mapped from class Tag in order to facilitate usage of the tag instance.


Constructor Summary
LinkedTagInstance()
          Constructs an instance without any arguments.
 
Method Summary
 boolean containsKey(java.lang.Object key)
          Returns true if the key exists in this map.
 java.lang.Object get(java.lang.Object key)
          Returns the depdendency mapped to by the given key.
 java.lang.Object getAttribute(java.lang.String attribute)
          For more information see Tag.getAttribute(java.lang.String, java.lang.Object, java.lang.Object).
 boolean getAttributeBoolean(java.lang.String attribute)
          For more information see Tag.getAttributeBoolean(java.lang.String, ooc.Dependencies).
 double getAttributeDouble(java.lang.String attribute)
          For more information see Tag.getAttributeDouble(java.lang.String, ooc.Dependencies).
 float getAttributeFloat(java.lang.String attribute)
          For more information see Tag.getAttributeFloat(java.lang.String, ooc.Dependencies).
 int getAttributeInteger(java.lang.String attribute)
          For more information see Tag.getAttributeInteger(java.lang.String, ooc.Dependencies).
 java.util.List getAttributeList(java.lang.String attribute)
          For more information see Tag.getAttributeList(java.lang.String).
 java.lang.String getAttributeRef(java.lang.String attributeName)
          For more information see Tag.getAttributeRef(java.lang.String).
 short getAttributeShort(java.lang.String name)
          For more information see Tag.getAttributeShort(java.lang.String, ooc.Dependencies).
 java.lang.String getAttributeString(java.lang.String attribute)
          For more information see Tag.getAttributeString(java.lang.String, ooc.Dependencies).
 Tag getAttributeTag(java.lang.String name)
          For more information see Tag.getAttributeTag(String name).
 java.util.Iterator getChildIterator()
          For more information see Tag.getChildIterator(ooc.Tag).
 java.util.Iterator getChildIteratorByName(java.lang.String tagName)
          For more information see Tag.getChildIteratorByName(String tagName).
 Container getContainer()
          Returns the tag handler from which this tag was generated.
 Tag getContainerTag(java.lang.String tagId)
           
 Tag getFirstChildTagByName(java.lang.String tagName)
          For more information see Tag.getFirstChildTagByName(java.lang.String).
 Tag getTag()
          Returns the tag of this tag instance.
 java.lang.String getTagId()
          For more information see Tag.getTagId().
 java.lang.Object getTagInstance()
           
 java.lang.Object getTagInstance(Dependencies dependencies)
           
 java.lang.String getTagRef()
          For more information see Tag.getTagRef().
 boolean hasAttributeValue(java.lang.String attribute)
          For more information see Tag.hasAttributeValue(java.lang.String).
 boolean hasChildTagByName(java.lang.String tagName)
          For more information see Tag.hasChildTagByName(java.lang.String).
 boolean hasChildTags()
          For more information see Tag.hasChildTags().
 boolean hasTag()
          Returns true if this tag instance has a tag.
 boolean isMutable()
          Returns true if this dependency map is mutable, else false;
 java.util.Set keySet()
          Returns the the key set mapping to the instances in this dependency map.
 java.lang.Object put(java.lang.Object key, java.lang.Object value)
          Add a new dependency into this map and return the old one, if any.
 java.lang.Object remove(java.lang.Object key)
          Remove the key-value pair from this depedency map.
 void setTag(Tag tag)
           
 void setupInstance()
          The default setup method which will be called.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LinkedTagInstance

public LinkedTagInstance()
Constructs an instance without any arguments.

Method Detail

getTag

public Tag getTag()
Returns the tag of this tag instance.

Returns:
the tag of this tag instance.

setTag

public void setTag(Tag tag)

hasTag

public boolean hasTag()
Returns true if this tag instance has a tag. This instance will always have a tag if it has been created using a tag instance.

Returns:
true if this tag instance has a tag.

setupInstance

public void setupInstance()
The default setup method which will be called.


keySet

public java.util.Set keySet()
Description copied from interface: Dependencies
Returns the the key set mapping to the instances in this dependency map.

Specified by:
keySet in interface Dependencies

get

public java.lang.Object get(java.lang.Object key)
Description copied from interface: Dependencies
Returns the depdendency mapped to by the given key.

Specified by:
get in interface Dependencies

containsKey

public boolean containsKey(java.lang.Object key)
Description copied from interface: Dependencies
Returns true if the key exists in this map.

Specified by:
containsKey in interface Dependencies

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)
Description copied from interface: Dependencies
Add a new dependency into this map and return the old one, if any.

Specified by:
put in interface Dependencies

remove

public java.lang.Object remove(java.lang.Object key)
Description copied from interface: Dependencies
Remove the key-value pair from this depedency map.

Specified by:
remove in interface Dependencies

isMutable

public boolean isMutable()
Description copied from interface: Dependencies
Returns true if this dependency map is mutable, else false;

Specified by:
isMutable in interface Dependencies

getContainer

public Container getContainer()
Returns the tag handler from which this tag was generated.

Returns:
the tag handler from which this tag was generated.

getTagId

public java.lang.String getTagId()
For more information see Tag.getTagId().


getContainerTag

public Tag getContainerTag(java.lang.String tagId)

hasAttributeValue

public boolean hasAttributeValue(java.lang.String attribute)
For more information see Tag.hasAttributeValue(java.lang.String).


getAttribute

public java.lang.Object getAttribute(java.lang.String attribute)
For more information see Tag.getAttribute(java.lang.String, java.lang.Object, java.lang.Object).


getAttributeString

public java.lang.String getAttributeString(java.lang.String attribute)
For more information see Tag.getAttributeString(java.lang.String, ooc.Dependencies).


getAttributeBoolean

public boolean getAttributeBoolean(java.lang.String attribute)
For more information see Tag.getAttributeBoolean(java.lang.String, ooc.Dependencies).


getAttributeFloat

public float getAttributeFloat(java.lang.String attribute)
For more information see Tag.getAttributeFloat(java.lang.String, ooc.Dependencies).


getAttributeDouble

public double getAttributeDouble(java.lang.String attribute)
For more information see Tag.getAttributeDouble(java.lang.String, ooc.Dependencies).


getAttributeInteger

public int getAttributeInteger(java.lang.String attribute)
For more information see Tag.getAttributeInteger(java.lang.String, ooc.Dependencies).


getAttributeShort

public short getAttributeShort(java.lang.String name)
For more information see Tag.getAttributeShort(java.lang.String, ooc.Dependencies).


getAttributeTag

public Tag getAttributeTag(java.lang.String name)
For more information see Tag.getAttributeTag(String name).


getAttributeList

public java.util.List getAttributeList(java.lang.String attribute)
For more information see Tag.getAttributeList(java.lang.String).


hasChildTags

public boolean hasChildTags()
For more information see Tag.hasChildTags().


hasChildTagByName

public boolean hasChildTagByName(java.lang.String tagName)
For more information see Tag.hasChildTagByName(java.lang.String).


getChildIteratorByName

public java.util.Iterator getChildIteratorByName(java.lang.String tagName)
For more information see Tag.getChildIteratorByName(String tagName).


getChildIterator

public java.util.Iterator getChildIterator()
For more information see Tag.getChildIterator(ooc.Tag).


getFirstChildTagByName

public Tag getFirstChildTagByName(java.lang.String tagName)
For more information see Tag.getFirstChildTagByName(java.lang.String).


getTagRef

public java.lang.String getTagRef()
For more information see Tag.getTagRef().


getAttributeRef

public java.lang.String getAttributeRef(java.lang.String attributeName)
For more information see Tag.getAttributeRef(java.lang.String).


getTagInstance

public java.lang.Object getTagInstance()

getTagInstance

public java.lang.Object getTagInstance(Dependencies dependencies)