//
   // This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v1.0.3-b18-fcs 
   // See <a href="http://java.sun.com/xml/jaxb">http://java.sun.com/xml/jaxb</a> 
   // Any modifications to this file will be lost upon recompilation of the source schema. 
   // Generated on: 2004.12.16 at 07:09:42 EST 
   //
   
   package net.sf.jour.config.impl.runtime;
   
  import javax.xml.bind.ValidationEvent;
  
  import org.relaxng.datatype.Datatype;
  import org.xml.sax.SAXException;
  import org.xml.sax.helpers.AttributesImpl;
  
  import com.sun.msv.grammar.IDContextProvider2;
  import com.sun.msv.util.LightStack;
  import com.sun.msv.util.StartTagInfo;
  import com.sun.msv.util.StringRef;
  import com.sun.msv.verifier.Acceptor;
  import com.sun.msv.verifier.regexp.StringToken;
  import com.sun.xml.bind.JAXBAssertionError;
  import com.sun.xml.bind.JAXBObject;
  import com.sun.xml.bind.RIElement;
  import com.sun.xml.bind.marshaller.IdentifiableObject;
  import com.sun.xml.bind.serializer.AbortSerializationException;
  import com.sun.xml.bind.serializer.Util;
  import com.sun.xml.bind.validator.Messages;
  
  /***
   * XMLSerializer that calls the native interface of MSV and performs validation.
   * Used in a pair with a ValidationContext.
   * 
   * @author  Kohsuke Kawaguchi
   */
  public class MSVValidator implements XMLSerializer, IDContextProvider2
  {
      /*** Current acceptor in use. */
      private Acceptor acceptor;
      
      /*** Context object that coordinates the entire validation effort. */
      private final ValidationContext context;
      
      /*** The object which we are validating. */
      private final ValidatableObject target;
      
      final DefaultJAXBContextImpl jaxbContext;
      
      /***
       * Acceptor stack. Whenever an element is found, the current acceptor is
       * pushed to the stack and new one is created.
       * 
       * LightStack is a light-weight stack implementation
       */
      private final LightStack stack = new LightStack();
  
      public NamespaceContext2 getNamespaceContext() {
          return context.getNamespaceContext();
      }
      
      /***
       * To use this class, call the static validate method.
       */
      private MSVValidator( DefaultJAXBContextImpl _jaxbCtx, ValidationContext _ctxt, ValidatableObject vo ) {
          jaxbContext = _jaxbCtx;
          acceptor = vo.createRawValidator().createAcceptor();
          context = _ctxt;
          target = vo;
      }
      
      /***
       * Validates the specified object and reports any error to the context.
       */
      public static void validate( DefaultJAXBContextImpl jaxbCtx, ValidationContext context, ValidatableObject vo )
              throws SAXException {
          try {
              new MSVValidator(jaxbCtx,context,vo)._validate();
          } catch( RuntimeException e ) {
              // sometimes when a conversion between Java object and
              // lexical value fails, it may throw an exception like
              // NullPointerException or NumberFormatException.
              //
              // catch them and report them as an error.
              context.reportEvent(vo,e);
          }
      }
      
      /*** performs the validation to the object specified in the constructor. */
      private void _validate() throws SAXException {
          context.getNamespaceContext().startElement();
          
          // validate attributes
          target.serializeURIs(this);
          
          endNamespaceDecls();
          
          target.serializeAttributes(this);
          
          endAttributes();
         
         // validate content model
         target.serializeBody(this);
         writePendingText();
         
         context.getNamespaceContext().endElement();
         
         if(!acceptor.isAcceptState(null)) {
             // some elements are missing
             // report error
             StringRef ref = new StringRef();
             acceptor.isAcceptState(ref);
             context.reportEvent(target,ref.str);
         }
     }
     
     public void endNamespaceDecls() throws SAXException {
         context.getNamespaceContext().endNamespaceDecls();
     }
     
     public void endAttributes() throws SAXException {
         if(!acceptor.onEndAttributes( null, null )) {
             // some required attributes are missing.
             // report a validation error
             // Note that we don't know which property of this object
             // causes this error.
             StringRef ref = new StringRef();
             StartTagInfo sti = new StartTagInfo(
                 currentElementUri,currentElementLocalName,currentElementLocalName,
                 emptyAttributes,this);
             acceptor.onEndAttributes( sti, ref );
             context.reportEvent(target,ref.str);
         }
     }
     
     /*** stores text reported by the text method. */
     private StringBuffer buf = new StringBuffer();
         
     public final void text( String text, String fieldName ) throws SAXException {
         if(text==null) {
             reportMissingObjectError(fieldName);
             return;
         }
         
         if(buf.length()!=0)
             buf.append(' ');
         buf.append(text);
     }
     
     public void reportMissingObjectError(String fieldName) throws SAXException {
         reportError(Util.createMissingObjectError(target,fieldName));
     }
     
 
     // used to keep attribute names until the endAttribute method is called.
     private String attNamespaceUri;
     private String attLocalName;
     private boolean insideAttribute;
 
     public void startAttribute( String uri, String local ) {
         // we will do the processing at the end element
         this.attNamespaceUri = uri;
         this.attLocalName = local;
         insideAttribute = true;
     }
     
     public void endAttribute() throws SAXException {
         insideAttribute = false;
         if(!acceptor.onAttribute2( attNamespaceUri, attLocalName,
             attLocalName /* we don't have QName, so just use the local name */,
             buf.toString(),
             this, null, null )) {
             
             // either the name was incorrect (which is quite unlikely),
             // or the value was wrong.
             // report an error
             StringRef ref = new StringRef();
             acceptor.onAttribute2( attNamespaceUri, attLocalName, attLocalName,
             buf.toString(), this, ref, null );
             
             context.reportEvent(target,ref.str);
         }
         
         buf = new StringBuffer();
     }
     
     private void writePendingText() throws SAXException {
         // assert(textBuf!=null);
         if(!acceptor.onText2( buf.toString(), this, null, null )) {
             // this text is invalid.
             // report an error
             StringRef ref = new StringRef();
             acceptor.onText2( buf.toString(), this, ref, null );
             context.reportEvent(target,ref.str);
         }
         
         if(buf.length()>1024)
             buf = new StringBuffer();
         else
             buf.setLength(0);
     }
     
     private String currentElementUri;
     private String currentElementLocalName;
     
     public void startElement( String uri, String local ) throws SAXException {
         writePendingText();
         
         context.getNamespaceContext().startElement();
         
         stack.push(acceptor);
         
         StartTagInfo sti = new StartTagInfo(uri,local,local,emptyAttributes,this);
         
         // we pass in an empty attributes, as there is just no way for us to
         // properly re-construct attributes. Fortunately, I know MSV is not using
         // attribute values, so this would work, but nevertheless this code is
         // ugly. This is one of the problems of the "middle" approach.
         Acceptor child = acceptor.createChildAcceptor( sti, null );
         if( child==null ) {
             // this element is invalid. probably, so this object is invalid
             // report an error
             StringRef ref = new StringRef();
             child = acceptor.createChildAcceptor( sti, ref );
             context.reportEvent(target,ref.str);
         }
         
         this.currentElementUri = uri;
         this.currentElementLocalName = local;
         
         acceptor = child;
     }
     
     public void endElement() throws SAXException {
         writePendingText();
         
         if(!acceptor.isAcceptState(null)) {
             // some required elements are missing
             // report error
             StringRef ref = new StringRef();
             acceptor.isAcceptState(ref);
             context.reportEvent(target,ref.str);
         }
         
         // pop the acceptor
         Acceptor child = acceptor;
         acceptor = (Acceptor)stack.pop();
         if(!acceptor.stepForward( child, null )) {
             // some required elements are missing.
             // report an error
             StringRef ref = new StringRef();
             acceptor.stepForward( child, ref );  // force recovery and obtain an error message.
             
             context.reportEvent(target,ref.str);
         }
         
         context.getNamespaceContext().endElement();
     }
     
     
     public void childAsAttributes( JAXBObject o, String fieldName ) throws SAXException {
         // do nothing
         
         // either the onMarshallableObjectInElement method
         // or the onMarshallableObjectInAttributeBody method will be 
         // called for every content tree objects.
         //
         // so we don't need to validate an object within this method.
     }
 
     public void childAsURIs( JAXBObject o, String fieldName ) throws SAXException {
         // ditto.
     }
 
     
     /*** An empty <code>Attributes</code> object. */
     private static final AttributesImpl emptyAttributes = new AttributesImpl();
     
     /*** namespace URI of dummy elements. TODO: allocate one namespace URI for this. */
     public static final String DUMMY_ELEMENT_NS =
         "http://java.sun.com/jaxb/xjc/dummy-elements";
 
     public void childAsBody( JAXBObject o, String fieldName ) throws SAXException {
         //final ValidatableObject vo = Util.toValidatableObject(o);
         final ValidatableObject vo =  jaxbContext.getGrammarInfo().castToValidatableObject(o);
 
         if(vo==null) {
             reportMissingObjectError(fieldName);
             return;
         }
         
         if( insideAttribute )   childAsAttributeBody(vo,fieldName);
         else                    childAsElementBody(o,vo);
     }
     
     private void childAsElementBody( Object o, ValidatableObject vo ) throws SAXException {
         String intfName = vo.getPrimaryInterface().getName();
         intfName = intfName.replace('$','.');
         
         // if the object implements the RIElement interface,
         // add a marker attribute to the dummy element.
         //
         // For example, if the object is org.acme.impl.FooImpl,
         // the dummy element will look like
         // <{DUMMY_ELEMENT_NS}org.acme.Foo
         //          {<URI of this element>}:<local name of this element>="" />
         // 
         // This extra attribute is used to validate wildcards.
 //        AttributesImpl atts;
 //        if(o instanceof RIElement) {
 //            RIElement rie = (RIElement)o;
 //            atts = new AttributesImpl();
 //            atts.addAttribute(
 //                rie.____jaxb_ri____getNamespaceURI(),
 //                rie.____jaxb_ri____getLocalName(),
 //                rie.____jaxb_ri____getLocalName(),  // use local name as qname
 //                "CDATA",
 //                "");    // we don't care about the attribute value
 //        } else
 //            atts = emptyAttributes;
             
         
         // feed a dummy element to the acceptor.
         StartTagInfo sti = new StartTagInfo(
             DUMMY_ELEMENT_NS,
             intfName,
             intfName/*just pass the local name as QName.*/,
             emptyAttributes,
             this );
         
             
         Acceptor child = acceptor.createChildAcceptor(sti,null);
         if(child==null) {
             // some required elements were missing. report errors
             StringRef ref = new StringRef();
             child = acceptor.createChildAcceptor(sti,ref);
             context.reportEvent(target,ref.str);
         }
         
         if(o instanceof RIElement) {
             RIElement rie = (RIElement)o;
             if(!child.onAttribute2(
                 rie.____jaxb_ri____getNamespaceURI(),
                 rie.____jaxb_ri____getLocalName(),
                 rie.____jaxb_ri____getLocalName(),
                 "",
                 null, null, null ))
                 
                 // this object is not a valid member of the wildcard
                 context.reportEvent(target,
                     Messages.format( Messages.INCORRECT_CHILD_FOR_WILDCARD,
                         rie.____jaxb_ri____getNamespaceURI(),
                         rie.____jaxb_ri____getLocalName() ));
         }
         
         child.onEndAttributes(sti,null);
         
         
         if(!acceptor.stepForward(child,null)) {
             // this can't be possible, as the dummy element was 
             // generated by XJC.
             throw new JAXBAssertionError();
         }
 
         
         // we need a separate validator instance to validate a child object
         context.validate(vo);
         
     }
     
     private void childAsAttributeBody( ValidatableObject vo, String fieldName ) throws SAXException {
         /*
         Dirty quick hack. When we split a schema into fragments, basically
         every chlid object needs a place holder in the fragment
         (so that the parent schema fragment can correctly validate that the
         child objects are at their supposed places.)
         
         For example, cconsider the following schema:
         
         imagine:
         <class>
           <attribute>
             <list>
               <oneOrMore>
                 <ref name="bar"/>
               </oneOrMore>
             </list>
           </attribute>
         </class>
         
         In our algorithm, the corresponding schema fragment will be:
         
         <class>
           <attribute>
             <list>
               <oneOrMore>
                 <value>\u0000full.class.name.of.BarImpl</value>
               </oneOrMore>
             </list>
           </attribute>
         </class>
         
         If we find a child object inside an attribute
         (that's why we are in this method BTW),
         we generate a class name (with a special marker \u0000).
         */
         
         // put a class name with a special marker \u0000. This char is an invalid
         // XML char, so sensible datatypes should reject this (although many
         // datatype implementations will accept it in actuality)
         text("\u0000"+vo.getPrimaryInterface().getName(),fieldName);
 
         // validate a child object
         context.validate(vo);
     }
 
 
     public void reportError( ValidationEvent e ) throws AbortSerializationException {
         context.reportEvent(target,e);
     }
 
 //
 //
 // ID/IDREF validation
 //
 //
     public String onID( IdentifiableObject owner, String value ) throws SAXException {
         return context.onID(target,value);
     }
     public String onIDREF( IdentifiableObject value ) throws SAXException {
         return context.onIDREF(target,value.____jaxb____getId());
     }
 
 //
 //  
 // ValidationContext implementation. Used by MSV to obtain
 // contextual information related to validation.
 //
 //
     public String getBaseUri() { return null; }
     public boolean isUnparsedEntity( String entityName ) {
         // abandon the validation of ENTITY type.
         return true;
     }
     public boolean isNotation( String notation ) {
         // abandon the validation of NOTATION type.
         return true;
     }
     public void onID( Datatype dt, StringToken s ) {
         // ID/IDREF validation will be done by ourselves.
         // so we will not rely on the validator to perform this check.
         // because we will use multiple instances of validators, so 
         // they cannot check global consistency.
         
         // see onID/onIDREF of the ValidationContext.
     }
     public String resolveNamespacePrefix( String prefix ) {
         return context.getNamespaceContext().getNamespaceURI(prefix);
     }
     
 }