com.exlibris.digitool.common.dnx

Class DnxSection

java.lang.Object

com.exlibris.digitool.common.dnx.DnxSection

public class DnxSection
extends java.lang.Object

DnxSection defines a layer above the org.dom4j.Element for accessing a DNX section

Author:

Tsachm

DnxSection defines a layer above the org.dom4j.Element for accessing a DNX section

Method Summary

Modifier and Type	Method and Description
DnxSectionRecord	createRecord() Creates a new record in the DNX section The operation adds a new record to the underlying org.dom4j.Element and to the arrayList of the existing DnxSectionRecord objects.
java.lang.String	getId() Returns the section's unique identifier, located in the "id" attribute.
DnxDocument	getParent() Returns the DNX document that contains this DNX section
java.util.List<DnxSectionRecord>	getRecordList() Returns the list of all records within the current section.
java.lang.String	getSectionKeyValue(java.lang.String sectionKeyId) Returns the value of the given section key as a string.
void	removeRecord(DnxSectionRecord record)
void	removeRecord(int recordIndex)
void	updateSectionKey(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

removeRecord

public void removeRecord(int recordIndex)

removeRecord

public void removeRecord(DnxSectionRecord record)

getId

public java.lang.String getId()

Returns the section's unique identifier, located in the "id" attribute.

Returns:

the section's unique identifier

createRecord

public DnxSectionRecord createRecord()

Creates a new record in the DNX section
The operation adds a new record to the underlying org.dom4j.Element
and to the arrayList of the existing DnxSectionRecord objects. For example:
DnxSection newDnxSection = dnxDocument.createSection(DNXConstants.CONTROL.sectionId);
DnxSectionRecord newDnxRecord = newDnxSection.createRecord();

Returns:

The newly created DnxSectionRecord object

getParent

public DnxDocument getParent()

Returns the DNX document that contains this DNX section

Returns:

the DNX document that contains this DNX section

getRecordList

public java.util.List<DnxSectionRecord> getRecordList()

Returns the list of all records within the current section.
For non-repeating sections (according to the profile), the method usually returns an array of size 1,
while for repeating sections the return can vary.

Returns:

the list of all records within the current section

updateSectionKey

public void updateSectionKey(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

getSectionKeyValue

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

Returns the value of the given section key as a string.
Note: The method assumes the first occurrence of a section record

Parameters:

sectionKeyId - the section key identifier

Returns:

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