Package ro.sync.ecss.extensions.dita.map

Class DITAMapResolvedReferencesCustomRuleMatcher

java.lang.Object

ro.sync.ecss.extensions.api.DocumentTypeAdvancedCustomRuleMatcher

ro.sync.ecss.extensions.dita.map.DITAMapResolvedReferencesCustomRuleMatcher

All Implemented Interfaces:

DocumentTypeCustomRuleMatcher, Extension

@API(type=INTERNAL,
     src=PUBLIC)
public class DITAMapResolvedReferencesCustomRuleMatcher
extends DocumentTypeAdvancedCustomRuleMatcher

Matches a specific DITA Map opened with resolved topics

Constructor Summary

Constructors

Constructor	Description
DITAMapResolvedReferencesCustomRuleMatcher()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()
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)	Check if the document type to which this custom rule belongs to should be used for the given document properties.

Methods inherited from class ro.sync.ecss.extensions.api.DocumentTypeAdvancedCustomRuleMatcher

matches, matches

Methods inherited from class java.lang.Object

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

Constructor Detail

DITAMapResolvedReferencesCustomRuleMatcher

public DITAMapResolvedReferencesCustomRuleMatcher()

Method Detail

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)

Description copied from class: DocumentTypeAdvancedCustomRuleMatcher

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.

Overrides:

matches in class DocumentTypeAdvancedCustomRuleMatcher

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. It may be null.

Returns:

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

See Also:

DocumentTypeAdvancedCustomRuleMatcher.matches(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes, java.util.Map, java.io.Reader)

getDescription

public java.lang.String getDescription()

Returns:

The description of the extension.

See Also:

Extension.getDescription()