ro.sync.ecss.extensions.api

Class DocumentTypeAdvancedCustomRuleMatcher

java.lang.Object

ro.sync.ecss.extensions.api.DocumentTypeAdvancedCustomRuleMatcher

All Implemented Interfaces:

DocumentTypeCustomRuleMatcher, Extension

Direct Known Subclasses:

DITAMapResolvedReferencesCustomRuleMatcher, HTML5CustomRuleMatcher

@API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class DocumentTypeAdvancedCustomRuleMatcher
extends java.lang.Object
implements DocumentTypeCustomRuleMatcher

Abstract class which can be implemented to provide custom matching to the document type it belongs to.

Since:

17.1

Constructor Summary

Constructors

Constructor and Description
DocumentTypeAdvancedCustomRuleMatcher()

Method Summary

Modifier and Type	Method and Description
boolean	matches(java.lang.String systemID, java.lang.String rootNamespace, java.lang.String rootLocalName, java.lang.String doctypePublicID, org.xml.sax.Attributes rootAttributes) Check if the document type to which this custom rule belongs to should be used for the given document properties.
boolean	matches(java.lang.String systemID, java.lang.String rootNamespace, java.lang.String rootLocalName, java.lang.String doctypePublicID, org.xml.sax.Attributes rootAttributes, java.io.Reader contentReader) Check if the document type to which this custom rule belongs to should be used for the given document properties.
boolean	matches(java.lang.String systemID, java.lang.String rootNamespace, java.lang.String rootLocalName, java.lang.String doctypePublicID, java.lang.String doctypeSystemID, org.xml.sax.Attributes rootAttributes, java.util.Map<java.lang.String,java.lang.String> queryParameters, java.io.Reader contentReader) Experimental API, subject to change.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ro.sync.ecss.extensions.api.Extension

getDescription

Constructor Detail

DocumentTypeAdvancedCustomRuleMatcher

public DocumentTypeAdvancedCustomRuleMatcher()

Method Detail

matches

public boolean matches(java.lang.String systemID,
                       java.lang.String rootNamespace,
                       java.lang.String rootLocalName,
                       java.lang.String doctypePublicID,
                       org.xml.sax.Attributes rootAttributes)

Description copied from interface: DocumentTypeCustomRuleMatcher

Check if the document type to which this custom rule belongs to should be used for the given document properties.

Specified by:

matches in interface DocumentTypeCustomRuleMatcher

Parameters:

systemID - The system ID of the current file in an URL format with not allowed characters corrected. For example: "file:/C:/path/to/file/file.xml"

rootNamespace - The namespace of the root.

rootLocalName - The root local name.

doctypePublicID - The public id of the specified DTD if any.

rootAttributes - The root attributes. The attributes are DOM level 2 and the namespaces are available for each one.

Returns:

true if the document type to which this rule belongs to will be used for the current file.

See Also:

DocumentTypeCustomRuleMatcher.matches(java.lang.String, java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

matches

public boolean matches(java.lang.String systemID,
                       java.lang.String rootNamespace,
                       java.lang.String rootLocalName,
                       java.lang.String doctypePublicID,
                       org.xml.sax.Attributes rootAttributes,
                       java.io.Reader contentReader)

Check if the document type to which this custom rule belongs to should be used for the given document properties. This method receives a reader over the entire content.

Parameters:

systemID - The system ID of the current file in an URL format with not allowed characters corrected. For example: "file:/C:/path/to/file/file.xml"

rootNamespace - The namespace of the root.

rootLocalName - The root local name.

doctypePublicID - The public id of the specified DTD if any.

rootAttributes - The root attributes. The attributes are DOM level 2 and the namespaces are available for each one.

contentReader - Reader over the entire XML content. Can be used for detection if all other parameters are not enough. The reader does not need to be reset or closed.

Returns:

true if the document type to which this rule belongs to will be used for the current file.

matches

public boolean matches(java.lang.String systemID,
                       java.lang.String rootNamespace,
                       java.lang.String rootLocalName,
                       java.lang.String doctypePublicID,
                       java.lang.String doctypeSystemID,
                       org.xml.sax.Attributes rootAttributes,
                       java.util.Map<java.lang.String,java.lang.String> queryParameters,
                       java.io.Reader contentReader)

Experimental API, subject to change. Check if the document type to which this custom rule belongs to should be used for the given document properties. This method receives a reader over the entire content.

Parameters:

systemID - The system ID of the current file in an URL format with not allowed characters corrected. For example: "file:/C:/path/to/file/file.xml"

rootNamespace - The namespace of the root.

rootLocalName - The root local name.

doctypePublicID - The public id of the specified DTD if any.

doctypeSystemID - The system id of the specified DTD if any.

rootAttributes - The root attributes. The attributes are DOM level 2 and the namespaces are available for each one.

queryParameters - The parameters which were set in the query string used to open this resource. May be null.

contentReader - Reader over the entire XML content. Can be used for detection if all other parameters are not enough. The reader does not need to be reset or closed.

Returns:

true if the document type to which this rule belongs to will be used for the current file.

Since:

23
*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.