Package org.biojava.bio.program.tagvalue
Class TagDropper
java.lang.Object
org.biojava.bio.program.tagvalue.SimpleTagValueWrapper
org.biojava.bio.program.tagvalue.TagDropper
- All Implemented Interfaces:
TagValueListener
,TagValueWrapper
Silently drop all tags except those specified, and pass the rest onto a
delegate.
- Since:
- 1.2
- Author:
- Matthew Pocock
-
Constructor Summary
ConstructorsConstructorDescriptionCreate a new TagDropper that will pass on all retained tags and values to tvl. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add a tag to retain.boolean
doRetain()
Find out if known tags are retained or dropped.void
endTag()
End the current tag.getTags()
Get the complete set of tags that are currently recognized.void
Remove a tag so that it will not be retained.void
setRetain
(boolean retain) Set wether known tags are to be retained or dropped.void
Start a new tag.void
value
(TagValueContext ctxt, Object value) A value has been seen.Methods inherited from class org.biojava.bio.program.tagvalue.SimpleTagValueWrapper
endRecord, getDelegate, setDelegate, startRecord
-
Constructor Details
-
TagDropper
public TagDropper() -
TagDropper
Create a new TagDropper that will pass on all retained tags and values to tvl. Initially, no tags will be retained.- Parameters:
tvl
- the TagValueListener to inform of all surviving events
-
-
Method Details
-
addTag
Add a tag to retain.- Parameters:
tag
- a tag that will be forwarded to the delegate
-
removeTag
Remove a tag so that it will not be retained.- Parameters:
tag
- a tag that will not be forwarded to the delegate
-
getTags
Get the complete set of tags that are currently recognized.- Returns:
- the Set of known tags
-
setRetain
Set wether known tags are to be retained or dropped.If retain is true, then all known tags will be passed on and all other tags will be discarded. If retain is true, then all known tags will be dropped and all others passed on.
- Parameters:
retain
- true if the tags are to be retained
-
doRetain
Find out if known tags are retained or dropped.- Returns:
- true if values are retained
-
startTag
Description copied from interface:TagValueListener
Start a new tag.- Specified by:
startTag
in interfaceTagValueListener
- Overrides:
startTag
in classSimpleTagValueWrapper
- Parameters:
tag
- the Object representing the new tag- Throws:
ParserException
- if the tag could not be started
-
endTag
Description copied from interface:TagValueListener
End the current tag.- Specified by:
endTag
in interfaceTagValueListener
- Overrides:
endTag
in classSimpleTagValueWrapper
- Throws:
ParserException
- if the tag could not be ended
-
value
Description copied from interface:TagValueListener
A value has been seen.- Specified by:
value
in interfaceTagValueListener
- Overrides:
value
in classSimpleTagValueWrapper
- Parameters:
ctxt
- a TagValueContext that could be used to push a sub-documentvalue
- the value Object observed- Throws:
ParserException
- if the value could not be processed
-