net.sf.mpxj.primavera

Class StructuredTextRecord

java.lang.Object

net.sf.mpxj.primavera.StructuredTextRecord

public class StructuredTextRecord
extends Object

Primavera makes use of "structured text records" in a number of places to represent complex data as a simple text field. The fields use bracket and pipe characters as delimiters. The typical structure starts with a record number, optionally followed by a record name. After this is a set of name-value pairs (which can be empty), then finally a list of child records following the same format (which again can be empty).

Field Summary

Fields

Modifier and Type	Field and Description
static StructuredTextRecord	EMPTY
static String	RECORD_NAME_ATTRIBUTE
static String	RECORD_NUMBER_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
StructuredTextRecord() Constructor to create an empty record.
StructuredTextRecord(Map<String,String> attributes, List<StructuredTextRecord> children) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(String name, String value) Add an attribute to the record.
void	addChild(StructuredTextRecord child) Add a child to the record.
String	getAttribute(String name) Retrieve an attribute by name.
Map<String,String>	getAttributes() Retrieve all attributes.
StructuredTextRecord	getChild(String name) Retrieve a child record by name.
List<StructuredTextRecord>	getChildren() Retrieve all child records.
String	getRecordName() Retrieve the record name.
String	getRecordNumber() Retrieve the record number.

Methods inherited from class java.lang.Object

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

Field Detail

RECORD_NUMBER_ATTRIBUTE

public static final String RECORD_NUMBER_ATTRIBUTE

See Also:

Constant Field Values

RECORD_NAME_ATTRIBUTE

public static final String RECORD_NAME_ATTRIBUTE

See Also:

Constant Field Values

EMPTY

public static final StructuredTextRecord EMPTY

Constructor Detail

StructuredTextRecord

public StructuredTextRecord()

Constructor to create an empty record.

StructuredTextRecord

public StructuredTextRecord(Map<String,String> attributes,
                            List<StructuredTextRecord> children)

Constructor.

Parameters:

attributes - attributes of this record

children - child records

Method Detail

getRecordName

public String getRecordName()

Retrieve the record name. The record name is optional so this may be null.

Returns:

record name

getRecordNumber

public String getRecordNumber()

Retrieve the record number.

Returns:

record number

getAttribute

public String getAttribute(String name)

Retrieve an attribute by name.

Parameters:

name - attribute name

Returns:

attribute value

getAttributes

public Map<String,String> getAttributes()

Retrieve all attributes.

Returns:

Map containing all attributes of this record

getChildren

public List<StructuredTextRecord> getChildren()

Retrieve all child records.

Returns:

List containing all child records

getChild

public StructuredTextRecord getChild(String name)

Retrieve a child record by name. Note that not all Structured Text Records in Primavera have a unique name for each child record. In some cases the caller is simply expected to retrieve the list of child records and iterate to process. Where child records have non-unique names, the first record encountered in the list with a matching name will be returned by this method.

Parameters:

name - child record name

Returns:

child record

addAttribute

public void addAttribute(String name,
                         String value)

Add an attribute to the record.

Parameters:

name - attribute name

value - attribute value

addChild

public void addChild(StructuredTextRecord child)

Add a child to the record.

Parameters:

child - StructuredTextRecord instance