public class ExtendedAdornedWord extends BaseAdornedWord implements AdornedWord, HasID, java.io.Externalizable
An ExtendedAdornedWord object extends the BaseAdornedWord object
with the following additional information about a single word spelling
externalized as an XML "
The following fields are inherited from the BaseAdornedWord object.
Modifier and Type | Class and Description |
---|---|
static class |
ExtendedAdornedWord.FrontMiddleBack
Front, middle, or back of text.
|
static class |
ExtendedAdornedWord.MainSide
Main or side text (paratext).
|
Modifier and Type | Field and Description |
---|---|
protected boolean |
blankPrecedes
Blank precedes flag.
|
protected java.lang.String |
divType
Div type.
|
protected boolean |
eos
End of sentence flag.
|
protected ExtendedAdornedWord.FrontMiddleBack |
frontMiddleBack
Front/middle/back text marker.
|
protected byte[] |
id
Word ID.
|
protected boolean |
inJumpTag
Jump tag flag.
|
protected boolean |
isGap
True if word corresponds to a
|
protected boolean |
isSpoken
Spoken word flag.
|
protected boolean |
isUnclear
Unclear flag.
|
protected boolean |
isVerse
Verse flag.
|
protected java.lang.String |
label
Word label.
|
protected ExtendedAdornedWord.MainSide |
mainSide
Main/side text marker.
|
protected ExtendedAdornedWord |
nextWord
Next word.
|
protected ExtendedAdornedWord |
nextWordPart
Next word part for this word.
|
protected int |
ord
Word ordinal.
|
protected int |
pageNumber
Page number on which word appears.
|
protected java.lang.String |
part
Word part flag.
|
protected byte[] |
path
XML word path.
|
protected ExtendedAdornedWord |
previousWord
Previous word.
|
protected ExtendedAdornedWord |
previousWordPart
Previous word part for this word.
|
protected java.lang.String |
rend
Rend.
|
protected int |
sentenceNumber
Sentence number.
|
protected static long |
serialVersionUID
Serial version UID.
|
protected java.lang.String |
type
Type.
|
protected int |
wordIndex
Word index in list of words.
|
protected int |
wordNumber
Word number within sentence.
|
protected java.lang.String |
wordText
Original, possibly partial, word text.
|
lemmata, partsOfSpeech, spelling, standardSpelling, token
Constructor and Description |
---|
ExtendedAdornedWord()
Create empty ExtendedAdornedWord object.
|
ExtendedAdornedWord(AdornedWord adornedWord,
java.lang.String id,
java.lang.String label,
java.lang.String part,
int ord,
int pageNumber,
boolean eos,
int wordNumber,
int sentenceNumber,
ExtendedAdornedWord.FrontMiddleBack frontMiddleBack,
ExtendedAdornedWord.MainSide mainSide,
java.lang.String tagPath,
boolean isSpoken,
boolean isVerse,
boolean isUnclear,
java.lang.String rend,
java.lang.String type,
ExtendedAdornedWord previousWord,
ExtendedAdornedWord previousWordPart,
boolean blankPrecedes)
Create ExtendedAdornedWord object.
|
ExtendedAdornedWord(java.lang.String wordText,
org.xml.sax.Attributes atts,
ExtendedAdornedWord.FrontMiddleBack frontMiddleBack,
ExtendedAdornedWord.MainSide mainSide,
java.lang.String tagPath,
int pageNumber,
boolean isSpoken,
boolean isVerse,
boolean inJumpTag,
boolean isUnclear,
java.lang.String divType,
ExtendedAdornedWord previousWord,
ExtendedAdornedWord previousWordPart,
boolean blankPrecedes)
Create ExtendedAdornedWord object.
|
ExtendedAdornedWord(java.lang.String wordText,
java.util.Map<java.lang.String,java.lang.String> atts,
ExtendedAdornedWord.FrontMiddleBack frontMiddleBack,
ExtendedAdornedWord.MainSide mainSide,
java.lang.String tagPath,
int pageNumber,
boolean isSpoken,
boolean isVerse,
boolean inJumpTag,
boolean isUnclear,
java.lang.String divType,
ExtendedAdornedWord previousWord,
ExtendedAdornedWord previousWordPart,
boolean blankPrecedes)
Create ExtendedAdornedWord object.
|
Modifier and Type | Method and Description |
---|---|
void |
appendRend(java.lang.String rend)
Append to rend.
|
void |
appendWordText(char[] ch,
int start,
int length)
Append characters to word text.
|
void |
appendWordText(java.lang.String s)
Append string to word text.
|
boolean |
getBlankPrecedes()
Get blank precedes flag.
|
java.lang.String |
getDivType()
Get div type.
|
boolean |
getEOS()
Get end of sentence flag.
|
ExtendedAdornedWord.FrontMiddleBack |
getFrontMiddleBack()
Get front/middle/back.
|
boolean |
getGap()
Get gap flag.
|
java.lang.String |
getID()
Get word ID.
|
boolean |
getInJumpTag()
Get in jump tag flag.
|
boolean |
getIsUnclear()
Get unclear flag.
|
java.lang.String |
getLabel()
Get word label.
|
ExtendedAdornedWord.MainSide |
getMainSide()
Get main or side.
|
ExtendedAdornedWord |
getNextWord()
Get next word.
|
ExtendedAdornedWord |
getNextWordPart()
Get next word part.
|
int |
getOrd()
Get word ordinal.
|
int |
getPageNumber()
Get page number in which word appears.
|
java.lang.String |
getPart()
Get part flag.
|
java.lang.String |
getPath()
Get path.
|
ExtendedAdornedWord |
getPreviousWord()
Get previous word.
|
ExtendedAdornedWord |
getPreviousWordPart()
Get previous word part.
|
java.lang.String |
getRend()
Get rend.
|
int |
getSentenceNumber()
Get sentence number for word.
|
boolean |
getSpoken()
Get spoken flag.
|
java.lang.String |
getType()
Get type.
|
boolean |
getVerse()
Get verse flag.
|
int |
getWordIndex()
Get word index.
|
int |
getWordNumber()
Get word number in sentence.
|
java.lang.String |
getWordText()
Get word text.
|
boolean |
isFirstPart()
Check if word is first (or only) part of a split word.
|
boolean |
isLastPart()
Check if word is last (or only) part of a split word.
|
boolean |
isMiddlePart()
Check if word is middle (or only) part of a split word.
|
boolean |
isSplitWord()
Check if word is a split word.
|
void |
readExternal(java.io.ObjectInput in)
Reads the work set from an object input stream (deserializes the object).
|
void |
setBlankPrecedes(boolean blankPrecedes)
Set blank precedes flag.
|
void |
setDivType(java.lang.String divType)
Set div type.
|
void |
setEOS(boolean eos)
Set end of sentence flag.
|
void |
setGap(boolean isGap)
Set gap flag.
|
void |
setID(java.lang.String id)
Set word ID.
|
void |
setInJumpTag(boolean inJumpTag)
Set in jump tag flag.
|
void |
setIsUnclear(boolean isUnclear)
Set unclear flag.
|
void |
setLabel(java.lang.String label)
Set word label.
|
void |
setNextWord(ExtendedAdornedWord nextWord)
Set next word.
|
void |
setNextWordPart(ExtendedAdornedWord nextWordPart)
Set next word part.
|
void |
setOrd(int ord)
Set word ordinal.
|
void |
setPageNumber(int pageNumber)
Set page number in which word appears.
|
void |
setPreviousWord(ExtendedAdornedWord previousWord)
Set previous word.
|
void |
setPreviousWordPart(ExtendedAdornedWord previousWordPart)
Set previous word part.
|
void |
setRend(java.lang.String rend)
Set rend.
|
void |
setSentenceNumber(int sentenceNumber)
Set sentence number for word.
|
void |
setSpoken(boolean isSpoken)
Set spoken flag.
|
void |
setType(java.lang.String type)
Set type.
|
void |
setVerse(boolean isVerse)
Set verse flag.
|
void |
setWordIndex(int wordIndex)
Set word index.
|
void |
setWordNumber(int wordNumber)
Set word number in sentence.
|
void |
setWordText(char[] ch,
int start,
int length)
Set word text.
|
void |
setWordText(java.lang.String wordText)
Set word text.
|
java.lang.String |
toString()
Return spelling for toString.
|
void |
writeExternal(java.io.ObjectOutput out)
Writes the work set to an object output stream (serializes the object).
|
clone, compareTo, equals, getLemmata, getPartsOfSpeech, getSpelling, getStandardSpelling, getToken, hashCode, setLemmata, setPartsOfSpeech, setSpelling, setStandardSpelling, setToken
finalize, getClass, notify, notifyAll, wait, wait, wait
getLemmata, getPartsOfSpeech, getSpelling, getStandardSpelling, getToken, setLemmata, setPartsOfSpeech, setSpelling, setStandardSpelling, setToken
protected byte[] id
protected java.lang.String wordText
protected java.lang.String part
N for an unsplit word. I for the the first part of a split word. M for the middle part(s) of a split word. F for the final part of a split word.
protected boolean eos
protected int ord
protected ExtendedAdornedWord.MainSide mainSide
protected boolean isSpoken
protected boolean isVerse
protected boolean inJumpTag
protected ExtendedAdornedWord.FrontMiddleBack frontMiddleBack
protected ExtendedAdornedWord previousWord
protected ExtendedAdornedWord nextWord
protected ExtendedAdornedWord previousWordPart
protected ExtendedAdornedWord nextWordPart
protected byte[] path
protected int sentenceNumber
protected int wordNumber
protected boolean isGap
protected int wordIndex
protected int pageNumber
protected java.lang.String label
protected boolean isUnclear
protected java.lang.String rend
protected java.lang.String type
protected java.lang.String divType
protected boolean blankPrecedes
protected static final long serialVersionUID
public ExtendedAdornedWord()
public ExtendedAdornedWord(java.lang.String wordText, org.xml.sax.Attributes atts, ExtendedAdornedWord.FrontMiddleBack frontMiddleBack, ExtendedAdornedWord.MainSide mainSide, java.lang.String tagPath, int pageNumber, boolean isSpoken, boolean isVerse, boolean inJumpTag, boolean isUnclear, java.lang.String divType, ExtendedAdornedWord previousWord, ExtendedAdornedWord previousWordPart, boolean blankPrecedes)
wordText
- atts
- XML attributes for a single
"frontMiddleBack
- Front/middle/back classification.mainSide
- Main/side classification.tagPath
- XML path to this tag.isSpoken
- Is spoken word flag.isVerse
- Is verse flag.inJumpTag
- In jump tag flag.isUnclear
- Is unclear word.divType
- Ancestral div type.previousWord
- Previous adorned word.previousWordPart
- Previous part for this word.blankPrecedes
- True if blank public ExtendedAdornedWord(java.lang.String wordText, java.util.Map<java.lang.String,java.lang.String> atts, ExtendedAdornedWord.FrontMiddleBack frontMiddleBack, ExtendedAdornedWord.MainSide mainSide, java.lang.String tagPath, int pageNumber, boolean isSpoken, boolean isVerse, boolean inJumpTag, boolean isUnclear, java.lang.String divType, ExtendedAdornedWord previousWord, ExtendedAdornedWord previousWordPart, boolean blankPrecedes)
wordText
- atts
- XML attributes for a single
word element.frontMiddleBack
- Front/middle/back classification.mainSide
- Main/side classification.tagPath
- XML path to this tag.isSpoken
- Is spoken word flag.isVerse
- Is verse flag.inJumpTag
- In jump tag flag.previousWord
- Previous adorned word.previousWordPart
- Previous part for this word.blankPrecedes
- True if blank public ExtendedAdornedWord(AdornedWord adornedWord, java.lang.String id, java.lang.String label, java.lang.String part, int ord, int pageNumber, boolean eos, int wordNumber, int sentenceNumber, ExtendedAdornedWord.FrontMiddleBack frontMiddleBack, ExtendedAdornedWord.MainSide mainSide, java.lang.String tagPath, boolean isSpoken, boolean isVerse, boolean isUnclear, java.lang.String rend, java.lang.String type, ExtendedAdornedWord previousWord, ExtendedAdornedWord previousWordPart, boolean blankPrecedes)
adornedWord
- Populated adorned word.id
- Word ID.label
- Word label.part
- String word part flag.ord
- Word ordinal.pageNumber
- Page number.eos
- EOS flag.wordNumber
- Word number in sentence.sentenceNumber
- Sentence number in sentence.frontMiddleBack
- Front/middle/back classification.mainSide
- Main/side classification.tagPath
- XML path to this tag.isSpoken
- Is spoken word flag.isVerse
- Is verse flag.isUnclear
- Is unclear flag.rend
- How to render word.type
- Type of word.previousWord
- Previous adorned word.previousWordPart
- Previous part for this word.blankPrecedes
- True if blank public java.lang.String getID()
public void setID(java.lang.String id)
id
- The word ID.public java.lang.String getPart()
public java.lang.String getPath()
public boolean isFirstPart()
public boolean isMiddlePart()
public boolean isLastPart()
public boolean isSplitWord()
public int getOrd()
public void setOrd(int ord)
ord
- The word ordinal.public int getSentenceNumber()
public void setSentenceNumber(int sentenceNumber)
sentenceNumber
- The sentence number in which this word appears.public int getWordNumber()
public void setWordNumber(int wordNumber)
wordNumber
- The word number in the sentence.public int getPageNumber()
public void setPageNumber(int pageNumber)
pageNumber
- The page number.public java.lang.String getLabel()
public void setLabel(java.lang.String label)
label
- The word label.public boolean getIsUnclear()
public void setIsUnclear(boolean isUnclear)
isUnclear
- True if word descends from unclear tag.public java.lang.String getRend()
public void setRend(java.lang.String rend)
rend
- rend string.public void appendRend(java.lang.String rend)
rend
- String to append to rend.public java.lang.String getType()
public void setType(java.lang.String type)
type
- type string.public boolean getEOS()
public void setEOS(boolean eos)
eos
- The end of sentence flag.public ExtendedAdornedWord.MainSide getMainSide()
public ExtendedAdornedWord.FrontMiddleBack getFrontMiddleBack()
public boolean getSpoken()
public void setSpoken(boolean isSpoken)
isSpoken
- True if word is spoken.public boolean getVerse()
public void setVerse(boolean isVerse)
isVerse
- True if word is in verse.public boolean getInJumpTag()
public void setInJumpTag(boolean inJumpTag)
inJumpTag
- True if word is in jump tag.public boolean getGap()
public void setGap(boolean isGap)
isGap
- True if word represents gap.public java.lang.String getWordText()
public void setWordText(java.lang.String wordText)
wordText
- The word text.public void setWordText(char[] ch, int start, int length)
ch
- Array of characters.start
- The starting position in the array.length
- The number of characters.public ExtendedAdornedWord getNextWord()
public void setNextWord(ExtendedAdornedWord nextWord)
nextWord
- The next word.public ExtendedAdornedWord getPreviousWord()
public void setPreviousWord(ExtendedAdornedWord previousWord)
previousWord
- The previous word.public ExtendedAdornedWord getNextWordPart()
public void setNextWordPart(ExtendedAdornedWord nextWordPart)
nextWordPart
- The next word part.public ExtendedAdornedWord getPreviousWordPart()
public void setPreviousWordPart(ExtendedAdornedWord previousWordPart)
previousWordPart
- The previous word part.public int getWordIndex()
public void setWordIndex(int wordIndex)
wordIndex
- The word index.public java.lang.String getDivType()
public void setDivType(java.lang.String divType)
divType
- Type= attribute from nearest ancestral div element.public boolean getBlankPrecedes()
public void setBlankPrecedes(boolean blankPrecedes)
blankPrecedes
- True if blank public void appendWordText(char[] ch, int start, int length)
ch
- Array of characters.start
- The starting position in the array.length
- The number of characters.public void appendWordText(java.lang.String s)
s
- String to append to word text.public java.lang.String toString()
toString
in class BaseAdornedWord
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
out
- Object output stream.java.io.IOException
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
in
- Object input stream.java.io.IOException
java.lang.ClassNotFoundException