You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by pi...@apache.org on 2005/09/07 21:42:15 UTC
svn commit: r279406 - in
/cocoon/branches/BRANCH_2_1_X/src/blocks/validation: conf/
java/org/apache/cocoon/components/validation/
java/org/apache/cocoon/components/validation/impl/
java/org/apache/cocoon/transformation/
Author: pier
Date: Wed Sep 7 12:42:07 2005
New Revision: 279406
URL: http://svn.apache.org/viewcvs?rev=279406&view=rev
Log:
Renaming "language" to "grammar".
Schema SAX handler is now simply a ContentHandler, not an Excalibur XMLConsumer
Modified:
cocoon/branches/BRANCH_2_1_X/src/blocks/validation/conf/validation.xmap
cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/Schema.java
cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/SchemaParser.java
cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/Validator.java
cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/AbstractSchema.java
cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/DefaultValidator.java
cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingSchema.java
cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingSchemaParser.java
cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/transformation/ValidatingTransformer.java
Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/validation/conf/validation.xmap
URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/blocks/validation/conf/validation.xmap?rev=279406&r1=279405&r2=279406&view=diff
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/blocks/validation/conf/validation.xmap (original)
+++ cocoon/branches/BRANCH_2_1_X/src/blocks/validation/conf/validation.xmap Wed Sep 7 12:42:07 2005
@@ -22,11 +22,11 @@
<map:transformer name="validate-relaxng"
logger="sitemap.transformer.validate"
src="org.apache.cocoon.transformation.ValidatingTransformer">
- <!--+ The "language" is either one of the language constants specified
+ <!--+ The "grammar" is either one of the grammar constants specified
| by the org.apache.cocoon.components.validation.Validator class
| or the component name with wich the SchemaParser was registered
| in "cocoon.xconf" (for example "jing").
+-->
- <language>http://relaxng.org/ns/structure/0.9</language>
+ <grammar>http://relaxng.org/ns/structure/0.9</grammar>
</map:transformer>
</xmap>
Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/Schema.java
URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/Schema.java?rev=279406&r1=279405&r2=279406&view=diff
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/Schema.java (original)
+++ cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/Schema.java Wed Sep 7 12:42:07 2005
@@ -16,14 +16,14 @@
package org.apache.cocoon.components.validation;
import org.apache.excalibur.source.SourceValidity;
-import org.apache.excalibur.xml.sax.XMLConsumer;
+import org.xml.sax.ContentHandler;
import org.xml.sax.ErrorHandler;
/**
* <p>An interface defining a schema used for validation of XML documents.</p>
*
* <p>A schema, by itself, simply provide access to its {@link SourceValidity}
- * (if any, for caching), and is able to create instances of {@link XMLConsumer}s
+ * (if any, for caching), and is able to create instances of {@link ContentHandler}s
* that will receive SAX Events and validate them.</p>
*
* @author <a href="mailto:pier@betaversion.org">Pier Fumagalli</a>
@@ -33,7 +33,7 @@
/**
* <p>Return the {@link SourceValidity} associated with this {@link Schema}.</p>
*
- * <p>If the current schema language allow inclusion of sub-schemas, the
+ * <p>If the current schema grammar allow inclusion of sub-schemas, the
* {@link SourceValidity} returned by this method <b>must</b> validate both the
* original schema URI <b>and</b> all its sub-schemas.</p>
*
@@ -42,33 +42,33 @@
public SourceValidity getValidity();
/**
- * <p>Return a new {@link XMLConsumer} instance that can be used to send SAX
+ * <p>Return a new {@link ContentHandler} instance that can be used to send SAX
* events to for proper validation.</p>
*
- * <p>By default, this method will create a {@link XMLConsumer} failing on the
+ * <p>By default, this method will create a {@link ContentHandler} failing on the
* first occurrence of an warning, error or fatal error . If this behavior is
* not suitable, use the {@link #newValidator(ErrorHandler)} method instead and
* specify an {@link ErrorHandler} suitable to your needs.</p>
*
- * <p>Once used, the returned {@link XMLConsumer} <b>can not</b> be reused.</p>
+ * <p>Once used, the returned {@link ContentHandler} <b>can't</b> be reused.</p>
*
- * @return a <b>non-null</b> {@link XMLConsumer} instance.
+ * @return a <b>non-null</b> {@link ContentHandler} instance.
*/
- public XMLConsumer newValidator();
+ public ContentHandler newValidator();
/**
- * <p>Return a new {@link XMLConsumer} instance that can be used to send SAX
+ * <p>Return a new {@link ContentHandler} instance that can be used to send SAX
* events to for proper validation.</p>
*
* <p>The specified {@link ErrorHandler} will be notified of all warnings or
* errors encountered validating the SAX events sent to the returned
- * {@link XMLConsumer}.</p>
+ * {@link ContentHandler}.</p>
*
- * <p>Once used, the returned {@link XMLConsumer} <b>can not</b> be reused.</p>
+ * <p>Once used, the returned {@link ContentHandler} <b>can not</b> be reused.</p>
*
* @param handler an {@link ErrorHandler} to notify of validation errors.
- * @return a <b>non-null</b> {@link XMLConsumer} instance.
+ * @return a <b>non-null</b> {@link ContentHandler} instance.
*/
- public XMLConsumer newValidator(ErrorHandler handler);
+ public ContentHandler newValidator(ErrorHandler handler);
}
Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/SchemaParser.java
URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/SchemaParser.java?rev=279406&r1=279405&r2=279406&view=diff
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/SchemaParser.java (original)
+++ cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/SchemaParser.java Wed Sep 7 12:42:07 2005
@@ -24,8 +24,8 @@
* <p>A component parsing schemas usable for XML validation and returning them as
* {@link Schema} instances.</p>
*
- * <p>This interface does not imply any requirement in terms of the language used
- * to produce {@link Schema} instances. Normally multiple-language selection is
+ * <p>This interface does not imply any requirement in terms of the grammar used
+ * to produce {@link Schema} instances. Normally multiple-grammar selection is
* provided through the {@link Validator} class.</p>
*
* <p>The only requirement imposed by this interface is that the final class
@@ -54,14 +54,14 @@
throws SAXException, IOException;
/**
- * <p>Return an array of {@link String}s containing all schema languages
+ * <p>Return an array of {@link String}s containing all schema grammars
* supported by this {@link SchemaParser}.</p>
*
* <p>All {@link String}s in the array returned by this method should be
- * valid language names as defined in the {@link Validator} class.</p>
+ * valid grammar names as defined in the {@link Validator} class.</p>
*
* @return a <b>non-null</b> array of {@link String}s.
*/
- public String[] getSupportedLanguages();
+ public String[] getSupportedGrammars();
}
Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/Validator.java
URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/Validator.java?rev=279406&r1=279405&r2=279406&view=diff
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/Validator.java (original)
+++ cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/Validator.java Wed Sep 7 12:42:07 2005
@@ -22,8 +22,8 @@
* between different {@link SchemaParser}.</p>
*
* <p>Selection can occur either normally, based on a component name specified in
- * the configuration files, or on the {@link SchemaParser#getSupportedLanguages()
- * supported languages} of the configured {@link SchemaParser}s.</p>
+ * the configuration files, or on the {@link SchemaParser#getSupportedGrammars()
+ * supported grammars} of the configured {@link SchemaParser}s.</p>
*
* @author <a href="mailto:pier@betaversion.org">Pier Fumagalli</a>
*/
@@ -32,17 +32,17 @@
/** <p>Role name to use when this component is accessed via a selector.</p> */
public static final String ROLE = Validator.class.getName();
- /** <p>The <a href="http://www.relaxng.org/">RELAX NG</a/> language identifer.</p> */
- public static final String LANGUAGE_RELAX_NG = "http://relaxng.org/ns/structure/0.9";
- /** <p>The <a href="http://www.xml.gr.jp/relax">RELAX CORE</a/> language identifer.</p> */
- public static final String LANGUAGE_RELAX_CORE = "http://www.xml.gr.jp/xmlns/relaxCore";
- /** <p>The <a href="http://www.xml.gr.jp/relax">RELAX NAMESPACE</a/> language identifer.</p> */
- public static final String LANGUAGE_RELAX_NS = "http://www.xml.gr.jp/xmlns/relaxNamespace";
- /** <p>The <a href="http://www.thaiopensource.com/trex/">TREX</a/> language identifer.</p> */
- public static final String LANGUAGE_TREX = "http://www.thaiopensource.com/trex";
- /** <p>The <a href="http://www.w3.org/XML/Schema">XML SCHEMA</a/> language identifer.</p> */
- public static final String LANGUAGE_XML_SCHEMA = "http://www.w3.org/2001/XMLSchema";
- /** <p>The <a href="http://www.w3.org/TR/REC-xml">XML DTD</a/> language identifer.</p> */
- public static final String LANGUAGE_XML_DTD = "http://www.w3.org/XML/1998/namespace";
+ /** <p>The <a href="http://www.relaxng.org/">RELAX NG</a/> grammar identifer.</p> */
+ public static final String GRAMMAR_RELAX_NG = "http://relaxng.org/ns/structure/0.9";
+ /** <p>The <a href="http://www.xml.gr.jp/relax">RELAX CORE</a/> grammar identifer.</p> */
+ public static final String GRAMMAR_RELAX_CORE = "http://www.xml.gr.jp/xmlns/relaxCore";
+ /** <p>The <a href="http://www.xml.gr.jp/relax">RELAX NAMESPACE</a/> grammar identifer.</p> */
+ public static final String GRAMMAR_RELAX_NS = "http://www.xml.gr.jp/xmlns/relaxNamespace";
+ /** <p>The <a href="http://www.thaiopensource.com/trex/">TREX</a/> grammar identifer.</p> */
+ public static final String GRAMMAR_TREX = "http://www.thaiopensource.com/trex";
+ /** <p>The <a href="http://www.w3.org/XML/Schema">XML SCHEMA</a/> grammar identifer.</p> */
+ public static final String GRAMMAR_XML_SCHEMA = "http://www.w3.org/2001/XMLSchema";
+ /** <p>The <a href="http://www.w3.org/TR/REC-xml">XML DTD</a/> grammar identifer.</p> */
+ public static final String GRAMMAR_XML_DTD = "http://www.w3.org/XML/1998/namespace";
}
Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/AbstractSchema.java
URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/AbstractSchema.java?rev=279406&r1=279405&r2=279406&view=diff
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/AbstractSchema.java (original)
+++ cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/AbstractSchema.java Wed Sep 7 12:42:07 2005
@@ -17,7 +17,7 @@
import org.apache.cocoon.components.validation.Schema;
import org.apache.excalibur.source.SourceValidity;
-import org.apache.excalibur.xml.sax.XMLConsumer;
+import org.xml.sax.ContentHandler;
import org.xml.sax.ErrorHandler;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;
@@ -49,19 +49,19 @@
}
/**
- * <p>Return a new {@link XMLConsumer} instance that can be used to send SAX
+ * <p>Return a new {@link ContentHandler} instance that can be used to send SAX
* events to for proper validation.</p>
*
- * <p>By default, this method will create a {@link XMLConsumer} failing on the
+ * <p>By default, this method will create a {@link ContentHandler} failing on the
* first occurrence of an warning, error or fatal error . If this behavior is
* not suitable, use the {@link #newValidator(ErrorHandler)} method instead and
* specify an {@link ErrorHandler} suitable to your needs.</p>
*
- * <p>Once used, the returned {@link XMLConsumer} <b>can not</b> be reused.</p>
+ * <p>Once used, the returned {@link ContentHandler} <b>can't</b> be reused.</p>
*
- * @return a <b>non-null</b> {@link XMLConsumer} instance.
+ * @return a <b>non-null</b> {@link ContentHandler} instance.
*/
- public XMLConsumer newValidator() {
+ public ContentHandler newValidator() {
ErrorHandler handler = new ErrorHandler() {
public void warning(SAXParseException e) throws SAXException {
throw e;
Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/DefaultValidator.java
URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/DefaultValidator.java?rev=279406&r1=279405&r2=279406&view=diff
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/DefaultValidator.java (original)
+++ cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/DefaultValidator.java Wed Sep 7 12:42:07 2005
@@ -177,13 +177,13 @@
this.logger.debug("SchemaParser " + selectionKey + " class" + className);
if (component instanceof SchemaParser) {
SchemaParser parser = (SchemaParser) component;
- String languages[] = parser.getSupportedLanguages();
- if (languages != null) {
- for (int k = 0; x < languages.length; x++) {
- if (this.selections.containsKey(languages[x])) continue;
- this.selections.put(languages[x], component);
+ String grammars[] = parser.getSupportedGrammars();
+ if (grammars != null) {
+ for (int k = 0; x < grammars.length; x++) {
+ if (this.selections.containsKey(grammars[x])) continue;
+ this.selections.put(grammars[x], component);
this.logger.debug("SchemaParser " + selectionKey
- + "provides language " + languages[x]);
+ + "provides grammar " + grammars[x]);
}
}
}
Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingSchema.java
URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingSchema.java?rev=279406&r1=279405&r2=279406&view=diff
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingSchema.java (original)
+++ cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingSchema.java Wed Sep 7 12:42:07 2005
@@ -17,12 +17,8 @@
import org.apache.cocoon.components.validation.Schema;
import org.apache.excalibur.source.SourceValidity;
-import org.apache.excalibur.xml.sax.NOPLexicalHandler;
-import org.apache.excalibur.xml.sax.XMLConsumer;
-import org.apache.excalibur.xml.sax.XMLConsumerProxy;
import org.xml.sax.ContentHandler;
import org.xml.sax.ErrorHandler;
-import org.xml.sax.ext.LexicalHandler;
import com.thaiopensource.util.PropertyMap;
import com.thaiopensource.util.PropertyMapBuilder;
@@ -52,26 +48,24 @@
}
/**
- * <p>Return a new {@link XMLConsumer} instance that can be used to send SAX
+ * <p>Return a new {@link ContentHandler} instance that can be used to send SAX
* events to for proper validation.</p>
*
* <p>The specified {@link ErrorHandler} will be notified of all warnings or
* errors encountered validating the SAX events sent to the returned
- * {@link XMLConsumer}.</p>
+ * {@link ContentHandler}.</p>
*
- * <p>Once used, the returned {@link XMLConsumer} <b>can not</b> be reused.</p>
+ * <p>Once used, the returned {@link ContentHandler} <b>can't</b> be reused.</p>
*
* @param errorHandler an {@link ErrorHandler} to notify of validation errors.
- * @return a <b>non-null</b> {@link XMLConsumer} instance.
+ * @return a <b>non-null</b> {@link ContentHandler} instance.
*/
- public XMLConsumer newValidator(ErrorHandler errorHandler) {
+ public ContentHandler newValidator(ErrorHandler errorHandler) {
if (errorHandler == null) errorHandler = new DraconianErrorHandler();
final PropertyMapBuilder builder = new PropertyMapBuilder();
ValidateProperty.ERROR_HANDLER.put(builder, errorHandler);
final PropertyMap properties = builder.toPropertyMap();
final Validator validator = this.schema.createValidator(properties);
- final ContentHandler contentHandler = validator.getContentHandler();
- final LexicalHandler lexicalHandler = new NOPLexicalHandler();
- return new XMLConsumerProxy(contentHandler, lexicalHandler);
+ return validator.getContentHandler();
}
}
Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingSchemaParser.java
URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingSchemaParser.java?rev=279406&r1=279405&r2=279406&view=diff
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingSchemaParser.java (original)
+++ cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/components/validation/impl/JingSchemaParser.java Wed Sep 7 12:42:07 2005
@@ -17,7 +17,6 @@
import java.io.IOException;
-import org.apache.avalon.framework.service.ServiceManager;
import org.apache.cocoon.components.validation.Schema;
import org.apache.cocoon.components.validation.SchemaParser;
import org.apache.cocoon.components.validation.Validator;
@@ -29,7 +28,7 @@
import com.thaiopensource.validate.rng.SAXSchemaReader;
/**
- * <p>A {@link SchemaParser} implementation for the RELAX NG language using the
+ * <p>A {@link SchemaParser} implementation for the RELAX NG grammar using the
* <a href="http://www.thaiopensource.com/relaxng/jing.html">JING</a> validation
* engine.</p>
*
@@ -37,12 +36,9 @@
*/
public class JingSchemaParser extends CachingSchemaParser {
- /** <p>The list of languages supported by the {@link JingSchemaParser}.</p> */
- private static final String[] LANGUAGES =
- new String[] { Validator.LANGUAGE_RELAX_NG };
-
- /** <p>The {@link ServiceManager} to resolve other components.</p> */
- private ServiceManager serviceManager;
+ /** <p>The list of grammars supported by the {@link JingSchemaParser}.</p> */
+ private static final String[] GRAMMARS =
+ new String[] { Validator.GRAMMAR_RELAX_NG };
/**
* <p>Create a new {@link JingSchemaParser} instance.</p>
@@ -76,13 +72,13 @@
}
/**
- * <p>Return an array of {@link String}s containing all schema languages
+ * <p>Return an array of {@link String}s containing all schema grammars
* supported by this {@link SchemaParser}.</p>
*
* <p>The {@link JingSchemaParser} supports only the
- * {@link Validator#LANGUAGE_RELAX_NG RELAX NG} language.</p>
+ * {@link Validator#GRAMMAR_RELAX_NG RELAX NG} grammar.</p>
*/
- public String[] getSupportedLanguages() {
- return LANGUAGES;
+ public String[] getSupportedGrammars() {
+ return GRAMMARS;
}
}
Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/transformation/ValidatingTransformer.java
URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/transformation/ValidatingTransformer.java?rev=279406&r1=279405&r2=279406&view=diff
==============================================================================
--- cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/transformation/ValidatingTransformer.java (original)
+++ cocoon/branches/BRANCH_2_1_X/src/blocks/validation/java/org/apache/cocoon/transformation/ValidatingTransformer.java Wed Sep 7 12:42:07 2005
@@ -44,8 +44,8 @@
* validating documents while being processed in a Cocoon pipeline.</p>
*
* <p>The only defined (but not required) configuration for this component is
- * <code><language><i>...string...</i></language></code>
- * indicating the language (or optionally the component name) for the
+ * <code><grammar><i>...string...</i></grammar></code>
+ * indicating the grammar (or optionally the component name) for the
* {@link Validator} instance providing access to {@link Schema}s.</p>
*
* @author <a href="mailto:pier@betaversion.org">Pier Fumagalli</a>
@@ -76,8 +76,8 @@
* <p>Configure this component instance.</p>
*
* <p>The only defined (but not required) configuration for this component is
- * <code><language><i>...string...</i></language></code>
- * indicating the language (or optionally the component name) for the
+ * <code><grammar><i>...string...</i></grammar></code>
+ * indicating the grammar (or optionally the component name) for the
* {@link Validator} instance providing access to {@link Schema}s.</p>
*
* @param configuration a {@link Configuration} instance for this component.
@@ -85,11 +85,11 @@
*/
public void configure(Configuration configuration)
throws ConfigurationException {
- String key = configuration.getChild("language").getValue();
+ String key = configuration.getChild("grammar").getValue();
try {
this.schemaParser = (SchemaParser) this.validator.select(key);
} catch (ServiceException exception) {
- String message = "Language or instance \"" + key + "\" not recognized";
+ String message = "Grammar or instance \"" + key + "\" not recognized";
throw new ConfigurationException(message, configuration, exception);
}
}