com.exlibris.digitool.common.dnx

Class DnxSectionRecord

java.lang.Object

com.exlibris.digitool.common.dnx.DnxSectionRecord

public class DnxSectionRecord
extends java.lang.Object

DnxSectionRecord defines a layer above the org.dom4j.Element for accessing a DNX record

Author:

Tsachm

DnxSectionRecord defines a layer above the org.dom4j.Element for accessing a DNX record

Method Summary

Modifier and Type	Method and Description
DnxRecordKey	createKey(java.lang.String id, java.lang.String q1, java.lang.String q2, java.lang.String value, boolean emptyValue) Creates a new section key in the current DNXRecord with id,q1,q2 and the value given as parameters The operation adds a new section key to the underlying org.dom4j.Element and to the arrayList of existing DnxRecordKey objects.
void	deleteAttributeByName(java.lang.String name)
void	deleteAttributeByName(java.lang.String name, int occurence)
org.dom4j.Element	getElement()
DnxRecordKey	getKeyById(java.lang.String id) Returns the DnxRecordKey object with the given ID that the current DNXSectionRecord contains
java.util.List<DnxRecordKey>	getKeylist() Returns the list of DnxRecordKey that the current DNXSectionRecord contains
java.lang.String	getSectionKeyValue(java.lang.String sectionKeyId) Returns the value of the given section key as a string.
void	updateKey(java.lang.String keyId, java.lang.String value) Updates or creates a section key value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

deleteAttributeByName

public void deleteAttributeByName(java.lang.String name)

deleteAttributeByName

public void deleteAttributeByName(java.lang.String name,
                                  int occurence)

createKey

public DnxRecordKey createKey(java.lang.String id,
                              java.lang.String q1,
                              java.lang.String q2,
                              java.lang.String value,
                              boolean emptyValue)

Creates a new section key in the current DNXRecord with id,q1,q2 and the value given as parameters
The operation adds a new section key to the underlying org.dom4j.Element
and to the arrayList of existing DnxRecordKey objects. For example:
DnxSection newDnxSection = dnxDocument.createSection(DNXConstants.CONTROL.sectionId);
DnxSectionRecord newDnxRecord = newDnxSection.createRecord();

DnxRecordKey newRecordKey = newDnxRecord.createKey("key1",null,null,"value1");

Parameters:

id - The identifier of the section key

q1 - The first qualifier of the section key

q2 - The second qualifier of the section key

value - The value of the section key

emptyValue - Flag that indicate that value can be empty

Returns:

The newly created DnxRecordKey object

getKeyById

public DnxRecordKey getKeyById(java.lang.String id)

Returns the DnxRecordKey object with the given ID that the current DNXSectionRecord contains

Parameters:

id - the identifier of the section key

Returns:

the DnxRecordKey object with the given ID, or "null" if the ID is not present

updateKey

public void updateKey(java.lang.String keyId,
                      java.lang.String value)

Updates or creates a section key value.
Note:
1) The method creates a key according to the given key identifier if no such key exists.
2) The method assumes the first occurrence of a section record.

Parameters:

keyId - the section key identifier

value - The new string value of the key, replacing the old string value

getKeylist

public java.util.List<DnxRecordKey> getKeylist()

Returns the list of DnxRecordKey that the current DNXSectionRecord contains

Returns:

the list of DnxRecordKey that the current DNXSectionRecord contains

getSectionKeyValue

public java.lang.String getSectionKeyValue(java.lang.String sectionKeyId)

Returns the value of the given section key as a string.

Parameters:

sectionKeyId - the section key identifier

Returns:

the value of the given sectionKey as a string or "null" if no such key exists

getElement

public org.dom4j.Element getElement()