com.batavia.xbrl.validation
Interface ValidationDocument

All Superinterfaces:

XbrlDocument, XmlDocument

public interface ValidationDocument
extends XbrlDocument

Interface for collection of validation messages that are add based on ids.

The messages them selves are located in a resource bundle.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

void	addAll(java.util.List msgs)
void	addAll(ValidationDocument doc) add all msgs form the param doc
java.lang.String	addId(java.lang.String messageId, java.lang.String[] vars, XmlElement origin)
java.lang.String	addId(java.lang.String messageId, java.lang.String[] vars, XmlElement origin, java.lang.String technicalrole, java.lang.String userRole, java.lang.String level)
java.lang.String	addId(java.lang.String messageId, XmlElement origin)
java.lang.String	addId(java.lang.String messageId, XmlElement origin, java.lang.String technicalrole, java.lang.String userRole, java.lang.String level)
java.lang.String	addMessage(java.lang.String message)
java.lang.String	addMessage(java.lang.String message, XmlElement origin)
java.lang.String	addMessage(java.lang.String message, XmlElement origin, java.lang.String technicalrole, java.lang.String userRole, java.lang.String level)
java.lang.String	addMessage(java.lang.String message, XmlElement origin, java.lang.String technicalrole, java.lang.String userRole, java.lang.String level, java.lang.String line, java.lang.String col)
void	clearValidationMessages()
java.lang.String	getAllMessagesText()
ValidationDocument	getCopy(java.lang.String level) create copy doc and ignore all msgs with lower importancy than given level
DiscoverableTaxonomySet	getCurrentDTS()
java.util.List	getMessages(java.lang.String technicalRole, java.lang.String userRole, java.lang.String level) Returns the messages that begin with the given arguments if they are not null.
java.util.List	getMessages(java.lang.String technicalRole, java.lang.String userRole, java.lang.String level, java.lang.String messageId) Returns the messages that begin with the given arguments if they are not null.
java.lang.String	getMessagesText(java.lang.String level)
void	setCurrentDTS(DiscoverableTaxonomySet currentDTS)
void	setObserver(ValidationDocumentObserver observer)
int	size() the number of msgs in this doc

Methods inherited from interface com.batavia.xbrl.XbrlDocument

fromXbrl, fromXbrl, setRoot, toXbrl

Methods inherited from interface com.batavia.xml.XmlDocument

fromXml, getRoot, getSystemId, setRoot, setSystemId, toXml, toXml, validate

Method Detail

addAll

void addAll(ValidationDocument doc)

add all msgs form the param doc

Parameters:

doc -

addAll

void addAll(java.util.List msgs)

size

int size()

the number of msgs in this doc

Returns:

addMessage

java.lang.String addMessage(java.lang.String message)

addId

java.lang.String addId(java.lang.String messageId,
                       XmlElement origin)

Parameters:

message - id

addId

java.lang.String addId(java.lang.String messageId,
                       java.lang.String[] vars,
                       XmlElement origin)

Parameters:

message - id

params - for in msg

getAllMessagesText

java.lang.String getAllMessagesText()

getMessagesText

java.lang.String getMessagesText(java.lang.String level)

addMessage

java.lang.String addMessage(java.lang.String message,
                            XmlElement origin)

Parameters:

message -

cause -

addId

java.lang.String addId(java.lang.String messageId,
                       XmlElement origin,
                       java.lang.String technicalrole,
                       java.lang.String userRole,
                       java.lang.String level)

Parameters:

message -

addId

java.lang.String addId(java.lang.String messageId,
                       java.lang.String[] vars,
                       XmlElement origin,
                       java.lang.String technicalrole,
                       java.lang.String userRole,
                       java.lang.String level)

Parameters:

message - id

params - for in msg

addMessage

java.lang.String addMessage(java.lang.String message,
                            XmlElement origin,
                            java.lang.String technicalrole,
                            java.lang.String userRole,
                            java.lang.String level)

Parameters:

message -

cause -

getMessages

java.util.List getMessages(java.lang.String technicalRole,
                           java.lang.String userRole,
                           java.lang.String level)

Returns the messages that begin with the given arguments if they are not null.

Parameters:

technicalRole - mostly the arcrole used in a network or one of the namespaces for xbrl-instance or w3c schema; may be null

userRole - mostly the linkrole used in a network or one of the namespaces for xbrl-instance or w3c schema; may be null

level - error, warning or ccf; may be null

Returns:

getMessages

java.util.List getMessages(java.lang.String technicalRole,
                           java.lang.String userRole,
                           java.lang.String level,
                           java.lang.String messageId)

Returns the messages that begin with the given arguments if they are not null.

Parameters:

technicalRole - mostly the arcrole used in a network or one of the namespaces for xbrl-instance or w3c schema; may be null

userRole - mostly the linkrole used in a network or one of the namespaces for xbrl-instance or w3c schema; may be null

level - error, warning or ccf; may be null

messageId - The identifier of the message

Returns:

addMessage

java.lang.String addMessage(java.lang.String message,
                            XmlElement origin,
                            java.lang.String technicalrole,
                            java.lang.String userRole,
                            java.lang.String level,
                            java.lang.String line,
                            java.lang.String col)

Parameters:

message -

cause -

getCopy

ValidationDocument getCopy(java.lang.String level)

create copy doc and ignore all msgs with lower importancy than given level

Parameters:

level - String with value cff, warning, error, fatalerror

Returns:

copy doc

setObserver

void setObserver(ValidationDocumentObserver observer)

getCurrentDTS

DiscoverableTaxonomySet getCurrentDTS()

setCurrentDTS

void setCurrentDTS(DiscoverableTaxonomySet currentDTS)

clearValidationMessages

void clearValidationMessages()