com.nt.udc.io

Class COSARAttrFormatter

java.lang.Object

com.nt.udc.io.COSARAttrFormatter

public class COSARAttrFormatter
extends java.lang.Object

This class provides the formatting mechanism for OSARs, based on lists of OSAR attributes described by means of an id, a type and a value obtained by evaluating an expression containing reference to values obtained from an external source of type IAttrSource.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	m_debugLevel
static int	UNKNOWN_ATTR_ERROR
static int	UNKNOWN_ATTR_IGNORE_NO_WARNING These constants are used in conjunction with the next field.
static int	UNKNOWN_ATTR_IGNORE_WARNING

Constructor Summary

Constructors

Constructor and Description
COSARAttrFormatter()
COSARAttrFormatter(ILogger iLogger)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	debug(java.lang.String fName, java.lang.String msg)
protected void	error(java.lang.String fName, java.lang.String msg)
int	getDebugLevel()
COSAR	getOSAR(IAttrSource attrSource) This function returns a new OSAR created from the layout associated with the default record-type.
COSAR	getOSAR(java.lang.String recordType, IAttrSource attrSource) This function returns a new OSAR created from the layout associated with the specified record-type.
COSAR	getOSAR(java.lang.String recordType, IAttrSource attrSource, IAttrCallback callbackObj) This function returns a new OSAR created from the layout associated with the specified record-type.
COSARAttr	getOSARAttr(java.lang.String recordType, java.lang.String key)
int	getUnknownAttrHandling()
boolean	hasRulesFor(java.lang.String recordType)
boolean	loadFromFile(java.lang.String filename) This function is used for loading the descriptions of OSAR attributes, consisting of: an OSAR attribute id + type and string keys, stored in a file.
boolean	loadFromVector(java.util.Vector cfgMapping) This function is used for loading the descriptions of OSAR attributes, consisting of: an OSAR attribute id + type and string keys, stored in a HashMap.
void	setDebugLevel(int debugLevel)
void	setUnknownAttrHandling(int unknownAttrHandling)
java.lang.String	toString() This function prints out a description of the mapping between String keys and OSAR attributes
protected void	warning(java.lang.String fName, java.lang.String msg)

Methods inherited from class java.lang.Object

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

Field Detail

m_debugLevel

protected static int m_debugLevel

UNKNOWN_ATTR_IGNORE_NO_WARNING

public static final int UNKNOWN_ATTR_IGNORE_NO_WARNING

These constants are used in conjunction with the next field.

See Also:

Constant Field Values

UNKNOWN_ATTR_IGNORE_WARNING

public static final int UNKNOWN_ATTR_IGNORE_WARNING

See Also:

Constant Field Values

UNKNOWN_ATTR_ERROR

public static final int UNKNOWN_ATTR_ERROR

See Also:

Constant Field Values

Constructor Detail

COSARAttrFormatter

public COSARAttrFormatter()
                   throws java.lang.Exception

Throws:

java.lang.Exception

COSARAttrFormatter

public COSARAttrFormatter(ILogger iLogger)
                   throws java.lang.Exception

Parameters:

iLogger - - Object implementing ILogger interface - used for logging errors, warnings, etc.

Throws:

java.lang.Exception

Method Detail

getDebugLevel

public int getDebugLevel()

getUnknownAttrHandling

public int getUnknownAttrHandling()

setDebugLevel

public void setDebugLevel(int debugLevel)

setUnknownAttrHandling

public void setUnknownAttrHandling(int unknownAttrHandling)

loadFromFile

public boolean loadFromFile(java.lang.String filename)

This function is used for loading the descriptions of OSAR attributes, consisting of: an OSAR attribute id + type and string keys, stored in a file.

Parameters:

filename - - Filename containing the mappings

Format: '['record:']' { }*

Returns:

true if successful, false otherwise

loadFromVector

public boolean loadFromVector(java.util.Vector cfgMapping)

This function is used for loading the descriptions of OSAR attributes, consisting of: an OSAR attribute id + type and string keys, stored in a HashMap.

Parameters:

cfgMapping - - matrix containing the mappings

Matrix line format:

Returns:

true if successful, false otherwise

toString

public java.lang.String toString()

This function prints out a description of the mapping between String keys and OSAR attributes

Overrides:

toString in class java.lang.Object

getOSARAttr

public COSARAttr getOSARAttr(java.lang.String recordType,
                    java.lang.String key)

hasRulesFor

public boolean hasRulesFor(java.lang.String recordType)

Returns:

true if there are any mapping-rules (a layout) associated with the record type, false otherwise.

getOSAR

public COSAR getOSAR(java.lang.String recordType,
            IAttrSource attrSource)

This function returns a new OSAR created from the layout associated with the specified record-type.

getOSAR

public COSAR getOSAR(java.lang.String recordType,
            IAttrSource attrSource,
            IAttrCallback callbackObj)

This function returns a new OSAR created from the layout associated with the specified record-type. A callback may be passed in for evaluating custom function calls.

getOSAR

public COSAR getOSAR(IAttrSource attrSource)

This function returns a new OSAR created from the layout associated with the default record-type.

error

protected void error(java.lang.String fName,
         java.lang.String msg)

warning

protected void warning(java.lang.String fName,
           java.lang.String msg)

debug

protected void debug(java.lang.String fName,
         java.lang.String msg)