Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKMatchesTextItemTS

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractDataObjectBase
        |
        +--com.ibm.mm.sdk.common.DKMatchesTextItemTS
All Implemented Interfaces:
DKConstant, DKConstantDL, dkDataObjectBase, DKMessageId, DKMessageIdDL, java.io.Serializable

public class DKMatchesTextItemTS
extends dkAbstractDataObjectBase
implements DKConstantDL, DKMessageIdDL, java.io.Serializable

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantDL
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdDL
DK_DL_MSG_INVNBR_TEXTMAPPING, DK_DL_MSG_MSGID_NOT_FOUND
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKMatchesTextItemTS()
          Constructs the text item and initializes it.
 
Method Summary
 void addNewLine()
          Adds a new line for this text.
 int getLength()
          Gets the match length in text string.
 int getMatchIndex()
          Gets the match index in text string.
 java.lang.String getObjectType()
          Gets the type of this object.
 int getOffset()
          Gets the match offset in text string.
 dkDataObjectBase getParent()
          Gets the parent object
 java.lang.String getText()
          Gets the document text.
 boolean isMatch()
          Checks if text item has match information.
 int numberOfMatches()
          Gets the number of matches
 int numberOfNewLines()
          Gets the number of new lines.
 void setLength(int length)
          Sets the match length in text string.
 void setMatchIndex(int index)
          Sets the match index in text string.
 void setOffset(int offset)
          Sets the match offset in text string.
 void setParent(dkDataObjectBase parentObject)
          Sets the parent object
 void setText(java.lang.String text)
          Sets the document text.
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDataObjectBase
getRootObject, protocol, setRootObject
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKMatchesTextItemTS

public DKMatchesTextItemTS()
Constructs the text item and initializes it.
Method Detail

getObjectType

public java.lang.String getObjectType()
Gets the type of this object.
Overrides:
getObjectType in class dkAbstractDataObjectBase
Returns:
the object type

getText

public java.lang.String getText()
Gets the document text.
Returns:
the document text

setText

public void setText(java.lang.String text)
Sets the document text.
Parameters:
text - the document text

isMatch

public boolean isMatch()
Checks if text item has match information.
Returns:
true if this text contains a match

addNewLine

public void addNewLine()
Adds a new line for this text.

getOffset

public int getOffset()
              throws DKException
Gets the match offset in text string.
Returns:
text match offset

setOffset

public void setOffset(int offset)
Sets the match offset in text string.
Parameters:
offset - the text match offset

getMatchIndex

public int getMatchIndex()
Gets the match index in text string.
Returns:
text match index

setMatchIndex

public void setMatchIndex(int index)
Sets the match index in text string.
Parameters:
index - the text match index

numberOfMatches

public int numberOfMatches()
Gets the number of matches
Returns:
number of matches in text item

getLength

public int getLength()
              throws DKException
Gets the match length in text string.
Returns:
text match length

setLength

public void setLength(int length)
Sets the match length in text string.
Parameters:
length - the text match length

numberOfNewLines

public int numberOfNewLines()
Gets the number of new lines.
Returns:
number of new lines

getParent

public dkDataObjectBase getParent()
Gets the parent object
Overrides:
getParent in class dkAbstractDataObjectBase
Returns:
the parent object. Returns null if no parent

setParent

public void setParent(dkDataObjectBase parentObject)
Sets the parent object
Overrides:
setParent in class dkAbstractDataObjectBase
Parameters:
parent - the parent object

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.