org.kohsuke.rngom.digested

Class DSchemaBuilderImpl

java.lang.Object

org.kohsuke.rngom.digested.DSchemaBuilderImpl

All Implemented Interfaces:

SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

public class DSchemaBuilderImpl
extends java.lang.Object
implements SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Parses as Parseable into a DPattern.

Field Summary

Fields

Modifier and Type	Field and Description
private org.w3c.dom.Document	dom Used to parse annotations.
private NameClassBuilder	ncb

Constructor Summary

Constructors

Constructor and Description
DSchemaBuilderImpl()

Method Summary

Modifier and Type	Method and Description
(package private) static DContainerPattern	addAll(DContainerPattern parent, java.util.List<DPattern> children)
(package private) static DUnaryPattern	addBody(DUnaryPattern parent, ParsedPattern _body, LocatorImpl loc)
DPattern	annotate(DPattern p, Annotation anno) Called when annotation is found right inside a pattern such as,
DPattern	annotateAfter(DPattern p, ElementWrapper e) Called when element annotation is found after a pattern.
DPattern	commentAfter(DPattern p, CommentListImpl comments)
DPattern	expandPattern(DPattern p) Called after all the parsing is done.
NameClassBuilder	getNameClassBuilder() Returns the NameClassBuilder, which is used to build name classes for this SchemaBuilder.
Annotation	makeAnnotations(CommentListImpl comments, Context context) Creates Annotations object to parse annotations on patterns.
DPattern	makeAttribute(NameClass nc, DPattern p, LocatorImpl loc, Annotation anno)
DPattern	makeChoice(java.util.List<DPattern> patterns, LocatorImpl loc, Annotation anno)
CommentListImpl	makeCommentList()
DataPatternBuilder	makeDataPatternBuilder(java.lang.String datatypeLibrary, java.lang.String type, LocatorImpl loc)
DPattern	makeElement(NameClass nc, DPattern p, LocatorImpl loc, Annotation anno)
ElementAnnotationBuilder	makeElementAnnotationBuilder(java.lang.String ns, java.lang.String localName, java.lang.String prefix, LocatorImpl loc, CommentListImpl comments, Context context)
DPattern	makeEmpty(LocatorImpl loc, Annotation anno)
DPattern	makeErrorPattern()
DPattern	makeExternalRef(Parseable current, java.lang.String uri, java.lang.String ns, Scope<DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl> scope, LocatorImpl loc, Annotation anno)
Grammar	makeGrammar(Scope parent)
DPattern	makeGroup(java.util.List<DPattern> patterns, LocatorImpl loc, Annotation anno)
DPattern	makeInterleave(java.util.List<DPattern> patterns, LocatorImpl loc, Annotation anno)
DPattern	makeList(DPattern p, LocatorImpl loc, Annotation anno)
LocatorImpl	makeLocation(java.lang.String systemId, int lineNumber, int columnNumber)
DPattern	makeMixed(DPattern p, LocatorImpl loc, Annotation anno)
DPattern	makeNotAllowed(LocatorImpl loc, Annotation anno)
DPattern	makeOneOrMore(DPattern p, LocatorImpl loc, Annotation anno)
DPattern	makeOptional(DPattern p, LocatorImpl loc, Annotation anno)
DPattern	makeText(LocatorImpl loc, Annotation anno)
DPattern	makeValue(java.lang.String datatypeLibrary, java.lang.String type, java.lang.String value, Context c, java.lang.String ns, LocatorImpl loc, Annotation anno)
DPattern	makeZeroOrMore(DPattern p, LocatorImpl loc, Annotation anno)
boolean	usesComments() If this SchemaBuilderis interested in actually parsing comments, this method returns true.
(package private) static DPattern	wrap(DPattern p, LocatorImpl loc, Annotation anno)

Methods inherited from class java.lang.Object

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

Field Detail

ncb

private final NameClassBuilder ncb

dom

private final org.w3c.dom.Document dom

Used to parse annotations.

Constructor Detail

DSchemaBuilderImpl

public DSchemaBuilderImpl()

Method Detail

getNameClassBuilder

public NameClassBuilder getNameClassBuilder()
                                     throws BuildException

Description copied from interface: SchemaBuilder

Returns the NameClassBuilder, which is used to build name classes for this SchemaBuilder. The NameClasses that are built will then be fed into this SchemaBuilderto further build RELAX NG patterns.

Specified by:

getNameClassBuilder in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Returns:

always return a non-null valid object. This method can (and probably should) always return the same object.

Throws:

BuildException

wrap

static DPattern wrap(DPattern p,
                     LocatorImpl loc,
                     Annotation anno)

addAll

static DContainerPattern addAll(DContainerPattern parent,
                                java.util.List<DPattern> children)

addBody

static DUnaryPattern addBody(DUnaryPattern parent,
                             ParsedPattern _body,
                             LocatorImpl loc)

makeChoice

public DPattern makeChoice(java.util.List<DPattern> patterns,
                           LocatorImpl loc,
                           Annotation anno)
                    throws BuildException

Specified by:

makeChoice in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Throws:

BuildException

makeInterleave

public DPattern makeInterleave(java.util.List<DPattern> patterns,
                               LocatorImpl loc,
                               Annotation anno)
                        throws BuildException

Specified by:

makeInterleave in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Throws:

BuildException

makeGroup

public DPattern makeGroup(java.util.List<DPattern> patterns,
                          LocatorImpl loc,
                          Annotation anno)
                   throws BuildException

Specified by:

makeGroup in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Throws:

BuildException

makeOneOrMore

public DPattern makeOneOrMore(DPattern p,
                              LocatorImpl loc,
                              Annotation anno)
                       throws BuildException

Specified by:

makeOneOrMore in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Throws:

BuildException

makeZeroOrMore

public DPattern makeZeroOrMore(DPattern p,
                               LocatorImpl loc,
                               Annotation anno)
                        throws BuildException

Specified by:

makeZeroOrMore in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Throws:

BuildException

makeOptional

public DPattern makeOptional(DPattern p,
                             LocatorImpl loc,
                             Annotation anno)
                      throws BuildException

Specified by:

makeOptional in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Throws:

BuildException

makeList

public DPattern makeList(DPattern p,
                         LocatorImpl loc,
                         Annotation anno)
                  throws BuildException

Specified by:

makeList in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Throws:

BuildException

makeMixed

public DPattern makeMixed(DPattern p,
                          LocatorImpl loc,
                          Annotation anno)
                   throws BuildException

Specified by:

makeMixed in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Throws:

BuildException

makeEmpty

public DPattern makeEmpty(LocatorImpl loc,
                          Annotation anno)

Specified by:

makeEmpty in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

makeNotAllowed

public DPattern makeNotAllowed(LocatorImpl loc,
                               Annotation anno)

Specified by:

makeNotAllowed in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

makeText

public DPattern makeText(LocatorImpl loc,
                         Annotation anno)

Specified by:

makeText in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

makeAttribute

public DPattern makeAttribute(NameClass nc,
                              DPattern p,
                              LocatorImpl loc,
                              Annotation anno)
                       throws BuildException

Specified by:

makeAttribute in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Throws:

BuildException

makeElement

public DPattern makeElement(NameClass nc,
                            DPattern p,
                            LocatorImpl loc,
                            Annotation anno)
                     throws BuildException

Specified by:

makeElement in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Throws:

BuildException

makeDataPatternBuilder

public DataPatternBuilder makeDataPatternBuilder(java.lang.String datatypeLibrary,
                                                 java.lang.String type,
                                                 LocatorImpl loc)
                                          throws BuildException

Specified by:

makeDataPatternBuilder in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Throws:

BuildException

makeValue

public DPattern makeValue(java.lang.String datatypeLibrary,
                          java.lang.String type,
                          java.lang.String value,
                          Context c,
                          java.lang.String ns,
                          LocatorImpl loc,
                          Annotation anno)
                   throws BuildException

Specified by:

makeValue in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Throws:

BuildException

makeGrammar

public Grammar makeGrammar(Scope parent)

Specified by:

makeGrammar in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Parameters:

parent - The parent scope. null if there's no parent scope. For example, if the complete document looks like the following:

      <grammar>
        <start><element name="root"><empty/></element></start>
      </grammar>
      

Then when the outer-most Grammar is created, it will receive the null parent.

annotate

public DPattern annotate(DPattern p,
                         Annotation anno)
                  throws BuildException

Description copied from interface: SchemaBuilder

Called when annotation is found right inside a pattern such as,

 <element name="foo">     <!-- this becomes 'P' -->
   <foreign:annotation /> <!-- this becomes 'A' -->
   ...
 </element>
 

Specified by:

annotate in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Throws:

BuildException

annotateAfter

public DPattern annotateAfter(DPattern p,
                              ElementWrapper e)
                       throws BuildException

Description copied from interface: SchemaBuilder

Called when element annotation is found after a pattern. such as,

 <element name="foo">
   <empty />              <!-- this becomes 'P' -->
   <foreign:annotation /> <!-- this becomes 'E' -->
 </element>
 

Specified by:

annotateAfter in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Throws:

BuildException

commentAfter

public DPattern commentAfter(DPattern p,
                             CommentListImpl comments)
                      throws BuildException

Specified by:

commentAfter in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Throws:

BuildException

makeExternalRef

public DPattern makeExternalRef(Parseable current,
                                java.lang.String uri,
                                java.lang.String ns,
                                Scope<DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl> scope,
                                LocatorImpl loc,
                                Annotation anno)
                         throws BuildException,
                                IllegalSchemaException

Specified by:

makeExternalRef in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Parameters:

current - Current grammar that we are parsing. This is what contains externalRef.

scope - The parent scope. null if there's no parent scope. See SchemaBuilder.makeGrammar(Scope) for more details about when this parameter can be null.

Throws:

BuildException

IllegalSchemaException

makeLocation

public LocatorImpl makeLocation(java.lang.String systemId,
                                int lineNumber,
                                int columnNumber)

Specified by:

makeLocation in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

makeAnnotations

public Annotation makeAnnotations(CommentListImpl comments,
                                  Context context)

Description copied from interface: SchemaBuilder

Creates Annotations object to parse annotations on patterns.

Specified by:

makeAnnotations in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Returns:

must be non-null.

makeElementAnnotationBuilder

public ElementAnnotationBuilder makeElementAnnotationBuilder(java.lang.String ns,
                                                             java.lang.String localName,
                                                             java.lang.String prefix,
                                                             LocatorImpl loc,
                                                             CommentListImpl comments,
                                                             Context context)

Specified by:

makeElementAnnotationBuilder in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

makeCommentList

public CommentListImpl makeCommentList()

Specified by:

makeCommentList in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

makeErrorPattern

public DPattern makeErrorPattern()

Specified by:

makeErrorPattern in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

usesComments

public boolean usesComments()

Description copied from interface: SchemaBuilder

If this SchemaBuilderis interested in actually parsing comments, this method returns true.

Returning false allows the schema parser to speed up the processing by skiping comment-related handlings.

Specified by:

usesComments in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

expandPattern

public DPattern expandPattern(DPattern p)
                       throws BuildException,
                              IllegalSchemaException

Description copied from interface: SchemaBuilder

Called after all the parsing is done.

This hook typically allows as SchemaBuilder to expand notAllowed (if it's following the simplification as in the spec.)

Specified by:

expandPattern in interface SchemaBuilder<NameClass,DPattern,ElementWrapper,LocatorImpl,Annotation,CommentListImpl>

Throws:

BuildException

IllegalSchemaException