com.ibm.di.entry
Class AttributeValue

java.lang.Object
  extended by com.ibm.di.entry.NodeImpl
      extended by com.ibm.di.entry.CharacterDataImpl
          extended by com.ibm.di.entry.AttributeValue
All Implemented Interfaces:
Serializable, Cloneable, CDATASection, CharacterData, Node, Text

public class AttributeValue
extends CharacterDataImpl
implements Serializable, Text, CDATASection, Cloneable

The AttributeValue class is used in conjunction with the Attribute object to store information about an attribute value. The class has a value and an operation properties associated with the value.

See Also:
Serialized Form

Field Summary
static int AV_ADD
          Used when a value has been added
static int AV_DELETE
          Used when a value has been deleted
static int AV_REPLACE
          Used when a value has been modified.
static int AV_UNCHANGED
          Used when a value is not changed
static int AV_UNDEFINED
          Used when a value does not have a defined operation code
 
Fields inherited from class com.ibm.di.entry.NodeImpl
parent
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Constructor Summary
AttributeValue(Object value)
          Creates an AttributeValue giving a value to be wrapped.
AttributeValue(Object value, int oper)
           
AttributeValue(Object value, int oper, boolean isText)
           
 
Method Summary
 AttributeValue clone()
           
 Node cloneNode(boolean deep)
           
 String getData()
           
 String getLocalName()
           
 String getNamespaceURI()
           
 String getNodeName()
           
 short getNodeType()
           
 int getOper()
           
 String getOperation()
          Return the operation code.
 String getPrefix()
           
 Object getValue()
           
 void setData(String data)
           
 void setNodeTypeText(boolean value)
          Changes the type of the node.
 void setOper(int oper)
           
 void setOperation(String oper)
           
 void setPrefix(String prefix)
           
 void setValue(Object value)
           
static int stringToOper(String oper)
           
 String toDeltaString()
           
 String toString()
           
 
Methods inherited from class com.ibm.di.entry.CharacterDataImpl
appendData, deleteData, getLength, getNodeValue, getWholeText, insertData, isElementContentWhitespace, replaceData, replaceWholeText, setNodeValue, splitText, substringData
 
Methods inherited from class com.ibm.di.entry.NodeImpl
appendChild, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getNextSibling, getOwnerDocument, getParentNode, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, internalLookupPrefix, internalNSLookup, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setTextContent, setUserData
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.w3c.dom.Text
getWholeText, isElementContentWhitespace, replaceWholeText, splitText
 
Methods inherited from interface org.w3c.dom.CharacterData
appendData, deleteData, getLength, insertData, replaceData, substringData
 
Methods inherited from interface org.w3c.dom.Node
appendChild, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setTextContent, setUserData
 

Field Detail

AV_UNDEFINED

public static final int AV_UNDEFINED
Used when a value does not have a defined operation code

See Also:
Constant Field Values

AV_UNCHANGED

public static final int AV_UNCHANGED
Used when a value is not changed

See Also:
Constant Field Values

AV_ADD

public static final int AV_ADD
Used when a value has been added

See Also:
Constant Field Values

AV_DELETE

public static final int AV_DELETE
Used when a value has been deleted

See Also:
Constant Field Values

AV_REPLACE

public static final int AV_REPLACE
Used when a value has been modified.

See Also:
Constant Field Values
Constructor Detail

AttributeValue

public AttributeValue(Object value)
Creates an AttributeValue giving a value to be wrapped. The operation code assigned by default is AV_REPLACE.

Parameters:
value - the value to be wrapped as an AttributeValue.

AttributeValue

public AttributeValue(Object value,
                      int oper)

AttributeValue

public AttributeValue(Object value,
                      int oper,
                      boolean isText)
Method Detail

getValue

public Object getValue()

setValue

public void setValue(Object value)

getOper

public int getOper()

getOperation

public String getOperation()
Return the operation code. This only has meaning if this value is inside an Entry generated by an Iterator with Delta enabled.

Returns:
- The operation code. Possible return values are :
"unchanged" - Used when a value is not changed
"add" - Used when a value has been added
"delete" - Used when a value has been deleted
"" - Used when a value does not have a defined operation code

setOper

public void setOper(int oper)

setOperation

public void setOperation(String oper)

stringToOper

public static int stringToOper(String oper)

toString

public String toString()
Overrides:
toString in class CharacterDataImpl

toDeltaString

public String toDeltaString()

setNodeTypeText

public void setNodeTypeText(boolean value)
Changes the type of the node.

Parameters:
value - - if this is true, subsequent calls to getNodeType() will return Node.TEXT_NODE, otherwise will return Node.CDATA_SECTION_NODE. *
Since:
7.0

clone

public AttributeValue clone()
Overrides:
clone in class Object

getData

public String getData()
               throws DOMException
Specified by:
getData in interface CharacterData
Throws:
DOMException

setData

public void setData(String data)
             throws DOMException
Specified by:
setData in interface CharacterData
Throws:
DOMException

cloneNode

public Node cloneNode(boolean deep)
Specified by:
cloneNode in interface Node

getNodeName

public String getNodeName()
Specified by:
getNodeName in interface Node
Overrides:
getNodeName in class NodeImpl

getLocalName

public String getLocalName()
Specified by:
getLocalName in interface Node

getNamespaceURI

public String getNamespaceURI()
Specified by:
getNamespaceURI in interface Node

getNodeType

public short getNodeType()
Specified by:
getNodeType in interface Node

getPrefix

public String getPrefix()
Specified by:
getPrefix in interface Node

setPrefix

public void setPrefix(String prefix)
               throws DOMException
Specified by:
setPrefix in interface Node
Throws:
DOMException