Package ro.sync.ecss.component.validation

Class AuthorDocumentPositionedInfo

java.lang.Object

ro.sync.document.DocumentPositionedInfo

ro.sync.ecss.component.validation.AuthorDocumentPositionedInfo

All Implemented Interfaces:

IAuthorDocumentPositionedInfo

@API(type=EXTENDABLE,
     src=PUBLIC)
public class AuthorDocumentPositionedInfo
extends DocumentPositionedInfo
implements IAuthorDocumentPositionedInfo

A document position info usually needs a line and column for the error. This extension allows you to specify either the problem AuthorNode or an offset/length interval in the Author content.

Field Summary

Fields inherited from class ro.sync.document.DocumentPositionedInfo

MESSAGE_CSS_STYLE, NOT_KNOWN, SEVERITY_ERROR, SEVERITY_FATAL, SEVERITY_INFO, SEVERITY_WARN

Fields inherited from interface ro.sync.ecss.component.validation.IAuthorDocumentPositionedInfo

CONTENT_DATA

Constructor Summary

Constructors

Constructor	Description
AuthorDocumentPositionedInfo(int severity, java.lang.String message, java.lang.String systemID, int startOffset, int length)	Constructor.
AuthorDocumentPositionedInfo(int severity, java.lang.String message, java.lang.String systemID, AuthorNode node)	Constructor.
AuthorDocumentPositionedInfo(int severity, java.lang.String message, AuthorNode node)	Constructor.
AuthorDocumentPositionedInfo(DocumentPositionedInfo dpi, AuthorNode node)	Constructor.

Method Summary

Modifier and Type	Method	Description
AuthorNode	getNode()
boolean	isSelectEntireNode()	Checks if the entire node should be selected.
void	setSelectEntireNode(boolean selectEntireNode)	Sets if the entire node should be selected or not.

Methods inherited from class ro.sync.document.DocumentPositionedInfo

asHTML, asHTML, asHTML, asHTML, asJSON, asJSON, asJSON, asText, asText, asText, asXML, asXML, asXML, equals, flipSeverity, getAdditionalHtmlContent, getAdditionalInfo, getAnchor, getColumn, getData, getDetailedExceptionInfo, getDITAAdditionalInfo, getECAdditionalInfo, getEndColumn, getEndLine, getEngineName, getErrorKey, getHTMLMessage, getImposedInitialPage, getLength, getLine, getMatchRange, getMessage, getMessageHighlightOffset, getMessageProvider, getMessageWithEngine, getMessageWithEngine, getMessageWithSeverity, getMessageWithSeverity, getMessageWithSeverity, getOffset, getOperationDescription, getPreferredEngineName, getSeverity, getSeverityAsString, getStartEndPositions, getSystemID, hashCode, isElementTarget, isHighlightToColumn, setAdditionalInfo, setAnchor, setColumn, setData, setDetailedExceptionInfo, setDITAAdditionalInfo, setECAdditionalInfo, setElementTarget, setEndColumn, setEndLine, setEngineName, setErrorKey, setHighlightToColumn, setHtmlMessageFragment, setImposedInitialPage, setLength, setLine, setMaskPasswordsInURLs, setMatchRange, setMessage, setMessageHighlightOffset, setOffset, setOperationDescription, setSeverity, setStartEndPositionsMap, setSystemID, setTemporaryPositions, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AuthorDocumentPositionedInfo

public AuthorDocumentPositionedInfo(DocumentPositionedInfo dpi,
                                    AuthorNode node)

Constructor.

Parameters:

dpi - The document positioned info to copy.

node - The author node. The node base URL will be used as a system ID location.

AuthorDocumentPositionedInfo

public AuthorDocumentPositionedInfo(int severity,
                                    java.lang.String message,
                                    AuthorNode node)

Constructor.

Parameters:

severity - Severity. One of the severity constants from class DocumentPositionedInfo: SEVERITY_ERROR, SEVERITY_FATAL, SEVERITY_INFO , SEVERITY_WARN.

message - Error message.

node - The author node. The node base URL will be used as a system ID location.

AuthorDocumentPositionedInfo

public AuthorDocumentPositionedInfo(int severity,
                                    java.lang.String message,
                                    java.lang.String systemID,
                                    AuthorNode node)

Constructor.

Parameters:

severity - Severity. One of the severity constants from class DocumentPositionedInfo: SEVERITY_ERROR, SEVERITY_FATAL, SEVERITY_INFO , SEVERITY_WARN.

message - Error message.

systemID - System ID

node - The author node.

AuthorDocumentPositionedInfo

public AuthorDocumentPositionedInfo(int severity,
                                    java.lang.String message,
                                    java.lang.String systemID,
                                    int startOffset,
                                    int length)

Constructor.

Parameters:

severity - Severity. One of the severity constants from class DocumentPositionedInfo: SEVERITY_ERROR, SEVERITY_FATAL, SEVERITY_INFO , SEVERITY_WARN.

message - Error message.

systemID - System ID

startOffset - The start offset of the problem, mapped in the Author content.

length - The length of the problem, mapped in the Author content.

Method Detail

getNode

public AuthorNode getNode()

Specified by:

getNode in interface IAuthorDocumentPositionedInfo

Returns:

The node to locate the message.

setSelectEntireNode

public void setSelectEntireNode(boolean selectEntireNode)

Sets if the entire node should be selected or not.

Parameters:

selectEntireNode - true if the entire node should be selected.

isSelectEntireNode

public boolean isSelectEntireNode()

Checks if the entire node should be selected.

Specified by:

isSelectEntireNode in interface IAuthorDocumentPositionedInfo

Returns:

true if the entire node should be selected.