/*

  * JBind

  *

  * Copyright (c) by Stefan Wachter. All rights reserved.

  *

  * Usage, modification, and redistribution is subject to license terms that are

  * available at 'http://www.jbind.org'. The JBind license is like the

  * 'Apache Software License V 1.1'.

  */

 package org.jbind.xml.facade;

 import java.io.IOException;

 import java.io.OutputStream;

 import java.io.OutputStreamWriter;

 import java.io.StringWriter;

 import java.io.UnsupportedEncodingException;

 import java.io.Writer;

 import java.net.URL;

 import java.util.ArrayList;

 import java.util.Iterator;

 import java.util.List;

 import java.util.Map;

 import javax.xml.transform.sax.SAXSource;

 import org.jbind.base.UnexpectedException;

 import org.jbind.xml.Config;

 import org.jbind.xml.code.IApplicationCode;

 import org.jbind.xml.code.IConfigurationCode;

 import org.jbind.xml.core.bridge.EqualsVisitor;

 import org.jbind.xml.core.bridge.IDataImpl;

 import org.jbind.xml.core.bridge.IDocumentImpl;

 import org.jbind.xml.core.bridge.IElementImpl;

 import org.jbind.xml.core.bridge.ImplReader;

 import org.jbind.xml.core.bridge.MarshalVisitor;

 import org.jbind.xml.core.bridge.SaxVisitor;

 import org.jbind.xml.core.cmp.ISchema;

 import org.jbind.xml.core.data.IAnyTypeData;

 import org.jbind.xml.core.data.IDataContext;

 import org.jbind.xml.instance.builder.DataBuilder;

 import org.jbind.xml.instance.builder.IImplBuilder;

 import org.jbind.xml.instance.builder.ImplBuilder;

 import org.jbind.xml.instance.builder.ValidationVisitor;

 import org.jbind.xml.msg.IConstraintViolations;

 import org.jbind.xml.msg.XmlException;

 import org.jbind.xml.msg.XmlMessages;

 import org.jbind.xml.schema.element.SchemaParser;

 import org.jbind.xml.schema.instantiation.ISchemaParser;

 import org.jbind.xml.schema.instantiation.ISchemaReader;

 import org.jbind.xml.schema.reader.Instantiator;

 import org.xml.sax.ContentHandler;

 import org.xml.sax.InputSource;

 import org.xml.sax.XMLReader;

 /**

  * Facade of the JBind framework that provides easy access to its core functionalities.

  */

   /**

    * Default encoding ({@value}).

    */

   public static final String DEFAULT_ENCODING = "UTF-8";

   /**

    * Creates a schema reader.

    *

    * @return <i>(required)</i>.

    */

 //    ISchemaParser parser = new SaxSchemaParser(ourEntityResolver, ourXPathFactory, ourRegExFactory);

   }

   /**

    * Reads a schema.

    * <p>

    * The schema will use generated classes and their package must

    * be configured in the schema itself or by the {@link org.jbind.xml.Config Config}

    * class.

    *

    * @param aUrl <i>(required)</i>.

    * @return <i>(required)</i>.

    */

   }

   /**

    * Creates a data builder.

    *

    * @param aContext <i>(optional)</i>.

    * @return <i>(required)</i>.

    */

   }

 //    return new SaxImplBuilder(ourEntityResolver, ourDataFactory, datBuilder, dataValidator, aContext);

   }

   /**

    * Validates a data object.

    *

    * @param aData <i>(required)</i>.

    * @param aContext <i>(optional)</i>.

    * @throws XmlException Raised iff the data object is not valid.

    */

     }

   }

   /**

    * Unmarshals a list of instance documents.

    *

    * @param aUrls <i>(required)</i>. A list of {@link URL URL}s.

    * @param aContext <i>(optional)</i>.

    *

    * @return <i>(required)</i>. A list of {@link IAnyTypeData IAnyTypeData} -

    * the root data of the unmarshalled documents in the same sequence as the supplied URLs.

    *

    * @throws XmlException Raised iff an instance document could not be unmarshalled.

    */

       }

     }

   }

   /**

    * Unmarshals an instance document.

    *

    * @param aUrl <i>(required)</i>.

    * @param aContext <i>(optional)</i>.

    *

    * @return <i>(required)</i>. The root data oj the instance.

    *

    * @throws XmlException Raised iff the instance document could not be unmarshalled.

    */

   }

   /**

    * Unmarshals an instance document.

    *

    * @param anInputSource <i>(required)</i>.

    * @param aContext <i>(optional)</i>.

    * @return <i>(required)</i>.

    *

    * @throws XmlException Raised iff the instance document could not be unmarshalled.

    */

     }

   }

   }

   }

   }

   }

   }

   }

   /**

    * Marshals a data object. No initial XML declaration (<?xml ... ?>) is output.

    *

    * @param aData <i>(required)</i>.

    * @param aWriter <i>(required)</i>.

    * @param aNamespaceToPrefixMapping <i>(optional)</i>. An initial mapping that

    * is output as "xmlns" attributes. If the data object that is unmarshalled

    * uses namespaces that are not contained in the initial mapping then new mappings

    * are created.

    * @param aTopLevelAttributes <i>(optional)</i>. A set of attributes that is

    * output as additional attributes of the root element. This feature can be used

    * to supply schema location attributes.

    *

    * @throws XmlException Raised iff the data object could not be unmarshalled.

    */

   }

   /**

    * Marshals a data object. No initial XML declaration (<?xml ... ?>) is output.

    *

    * @param aData <i>(required)</i>. The data that is marshalled.

    * @param aNamespaceToPrefixMapping <i>(optional)</i>. (cf. {@link #marshal(Writer, IAnyTypeData, Map, Map)})

    * @param aTopLevelAttributes <i>(optional)</i>. (cf. {@link #marshal(Writer, IAnyTypeData, Map, Map)})

    */

   }

   /**

    * Marshals a data object.

    *

    * @param anOutputStream <i>(required)</i>. The stream that is used for output.

    * @param anEncoding <i>(optional)</i>. If no encoding is specified then

    * the {@link #DEFAULT_ENCODING DEFAULT_ENCODING} is used.

    * @param anOutputXmlDeclaration Controls whether the initial XML declaration

    * <?xml version="1.0" encoding="..."?> or not.

    * @param aData <i>(required)</i>. The data that is marshalled.

    * @param aNamespaceToPrefixMapping <i>(optional)</i>. (cf. {@link #marshal(Writer, IAnyTypeData, Map, Map)})

    * @param aTopLevelAttributes <i>(optional)</i>. (cf. {@link #marshal(Writer, IAnyTypeData, Map, Map)})

    */

     } catch (UnsupportedEncodingException e) {

     }

   }

   /**

    * Outputs the XML declaration &quot;<?xml version ...&nbsp;?>&quot;

    *

    * @param aWriter <i>(required)</i>.

    * @param anEncoding <i>(required)</i>.

    */

     } catch (IOException e) {

     }

   }

   }

   /**

    * Check value equality of two data objects. For simple data objects their

    * simple content is compared whereas for complex data object the whole

    * data trees (including attributes) are compared.

    *

    * @param aData1 <i>(optional)</i>.

    * @param aData2 <i>(optional)</i>.

    * @return Returns <code>true</code> if the two data objects have the same value.

    */

       } catch (XmlException e) {

       }

     } else {

     }

   }

   /**

    * Creates a SAXSource that can be supplied to a stylesheet processor.

    *

    * @param aData <i>(required)</i>. The data that is output by SAX.

    * @return <i>(required)</i>.

    */

   }

 }