Package org.exolab.castor.xml.dtd

Class Converter

  • public class Converter
extends java.lang.Object
    Class containing methods to parse and convert XML DTD documents to corresponding XML Schema documents. Also contains simple command line interface to read an XML DTD file and create corresponding XML Schema object.
    Version:
    $Revision: 8519 $ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $
    Author:
    Alexander Totok

    • Constructor Summary

      Constructors 
      Constructor Description
      Converter()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      AttributeDecl convertAttribute​(Attribute dtdAttribute, Schema schema)
      Convert DTD Attribute declaration to Schema Attribute Declaration.
      Particle convertContentParticle​(ContentParticle dtdContent, Schema schema)
      Method to convert ContentParticle object, used to implement element content in the DTD object model, to the corresponding object in the Schema object model: either Group or ElementDecl.
      ElementDecl convertDTDElementToSchemaElement​(Element dtdElement, Schema schema)
      Convert DTD Element declaration to Schema Element Declaration.
      Schema convertDTDObjectToSchemaObject​(DTDdocument dtd, java.lang.String targetNamespace, java.util.Map nameSpaceMap)
      Convert DTD document object to corresponding Schema object.
      void convertDTDtoSchema​(java.io.Reader reader, java.io.Writer writer)
      Convert DTD document to corresponding XML Schema document.
      void convertDTDtoSchema​(java.io.Reader reader, java.io.Writer writer, java.lang.String targetNameSpace, java.util.Map<java.lang.String,​java.lang.String> nameSpaceMap)
      Convert DTD document to corresponding XML Schema document.
      protected static boolean isNameSpacePrefix​(java.lang.String nameSpacePrefix2test)  
      static void main​(java.lang.String[] args)
      Simple command line interface to read an XML DTD file and create corresponding XML Schema file.
      void marshalSchema​(Schema schema, java.io.Writer writer)
      Marshals XML Schema to output char stream.
      DTDdocument parseDTD​(java.io.Reader reader)
      Parses text of a DTD document and returns corresponding DTD document object.
      protected static java.util.Map<java.lang.String,​java.lang.String> parseNamespace​(java.lang.String nameSpaceArg)  
      void process​(java.io.Reader in, java.io.Writer out, java.lang.String encoding, java.lang.String targetNamespace, java.util.Map<java.lang.String,​java.lang.String> namespaces)  
      void process​(java.lang.String dtdFile, java.lang.String schemaFile, java.lang.String encoding, java.lang.String targetNamespace, java.util.Map<java.lang.String,​java.lang.String> namespaces)  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • NAME_SPACE_PREFIX_KEY

        public static final java.lang.String NAME_SPACE_PREFIX_KEY
        See Also:
        Constant Field Values

      • DEFAULT_NAME_SPACE_PREFIX

        public static final java.lang.String DEFAULT_NAME_SPACE_PREFIX
        See Also:
        Constant Field Values

      • DEFAULT_NAME_SPACE

        public static final java.lang.String DEFAULT_NAME_SPACE
        See Also:
        Constant Field Values

    • Constructor Detail

      • Converter

        public Converter()

    • Method Detail

      • main

        public static void main​(java.lang.String[] args)
                 throws java.io.IOException,
                        DTDException,
                        SchemaException,
                        org.xml.sax.SAXException
        Simple command line interface to read an XML DTD file and create corresponding XML Schema file. Usage: 
         java org.exolab.castor.xml.dtd.Converter  dtd_file xsd_file [character_encoding]
    [-tns=[TNS_PREFIX:]NAMESPACE_URI]
    [-xmlns=[TNS_PREFIX:]NAMESPACE_URI]*
 
 dtd_file: name of the input DTD file
 xsd_file: name of the output Schema file
 character_encoding: name of the character encoding,
            if not specified, ASCII is chosen
        Help message is provided.
        Throws:
        DTDException - if the input DTD document is malformed.
        SchemaException - if Schema object can not be created.
        org.xml.sax.SAXException - if an error occured during marshalling of schema object constructed from the DTD document.
        java.io.IOException

      • process

        public void process​(java.lang.String dtdFile,
                    java.lang.String schemaFile,
                    java.lang.String encoding,
                    java.lang.String targetNamespace,
                    java.util.Map<java.lang.String,​java.lang.String> namespaces)
             throws SchemaException,
                    DTDException,
                    java.io.IOException,
                    org.xml.sax.SAXException
        Parameters:
        dtdFile - Location of the DTD file.
        schemaFile - Location of the XML schema file.
        encoding - (Optional) encoding.
        targetNamespace - (Optional) target name space.
        namespaces - (Optional) XML name spaces.
        Throws:
        SchemaException
        DTDException
        java.io.IOException
        org.xml.sax.SAXException

      • process

        public void process​(java.io.Reader in,
                    java.io.Writer out,
                    java.lang.String encoding,
                    java.lang.String targetNamespace,
                    java.util.Map<java.lang.String,​java.lang.String> namespaces)
             throws SchemaException,
                    DTDException,
                    java.io.IOException,
                    org.xml.sax.SAXException
        Parameters:
        in - Location of the DTD file.
        out - Location of the XML schema file.
        encoding - (Optional) encoding.
        targetNamespace - (Optional) target name space.
        namespaces - (Optional) XML name spaces.
        Throws:
        SchemaException
        DTDException
        java.io.IOException
        org.xml.sax.SAXException

      • parseNamespace

        protected static java.util.Map<java.lang.String,​java.lang.String> parseNamespace​(java.lang.String nameSpaceArg)

      • isNameSpacePrefix

        protected static boolean isNameSpacePrefix​(java.lang.String nameSpacePrefix2test)

      • convertDTDtoSchema

        public void convertDTDtoSchema​(java.io.Reader reader,
                               java.io.Writer writer,
                               java.lang.String targetNameSpace,
                               java.util.Map<java.lang.String,​java.lang.String> nameSpaceMap)
                        throws DTDException,
                               SchemaException,
                               java.io.IOException,
                               org.xml.sax.SAXException
        Convert DTD document to corresponding XML Schema document.
        Parameters:
        reader - reader of the input DTD document.
        writer - writer to the output Schema document.
        targetNameSpaceMap - (Optional) XML target name space for the XML schema.
        nameSpaceMap - (Optional) XML name space declarations for the XML schema.
        Throws:
        DTDException - if the DTD document is syntactically or semantically not correct.
        SchemaException - if Schema object can not be created.
        java.io.IOException - if there is an I/O problem with the reader or writer.
        org.xml.sax.SAXException - if an error occured during schema object marshalling.

      • convertDTDtoSchema

        public void convertDTDtoSchema​(java.io.Reader reader,
                               java.io.Writer writer)
                        throws DTDException,
                               SchemaException,
                               java.io.IOException,
                               org.xml.sax.SAXException
        Convert DTD document to corresponding XML Schema document.
        Parameters:
        reader - reader of the input DTD document.
        writer - writer to the output Schema document.
        Throws:
        DTDException - if the DTD document is syntactically or semanticly not correct.
        SchemaException - if Schema object can not be created.
        java.io.IOException - if there is an I/O problem with the reader or writer.
        org.xml.sax.SAXException - if an error occured during schema object marshalling.

      • parseDTD

        public DTDdocument parseDTD​(java.io.Reader reader)
                     throws DTDException
        Parses text of a DTD document and returns corresponding DTD document object. It is left to constructor of the reader to set up character encoding correctly. This means that method read of the reader is used to get next character, assuming it returns appropriate values.
        Parameters:
        reader - input char stream reader. It is recommended to use class java.io.InputStreamReader as a reader, which allows to set desired character encoding.
        Returns:
        DTD document object corresponding to the input text of a DTD document.
        Throws:
        DTDException - if the DTD document is syntactically or semanticly not correct.

      • convertDTDObjectToSchemaObject

        public Schema convertDTDObjectToSchemaObject​(DTDdocument dtd,
                                             java.lang.String targetNamespace,
                                             java.util.Map nameSpaceMap)
                                      throws DTDException,
                                             SchemaException
        Convert DTD document object to corresponding Schema object.
        Parameters:
        dtd - input XML DTD document object.
        nameSpacePrefix -
        nameSpace -
        Returns:
        corresponding XML Schema object.
        Throws:
        DTDException - if the input DTD document is malformed.
        SchemaException - if Schema object can not be created.

      • convertDTDElementToSchemaElement

        public ElementDecl convertDTDElementToSchemaElement​(Element dtdElement,
                                                    Schema schema)
                                             throws DTDException,
                                                    SchemaException
        Convert DTD Element declaration to Schema Element Declaration.
        Parameters:
        dtdElement - DTD Element declaration.
        schema - Schema owning Element declaration.
        Returns:
        corresponding Schema Element declaration.
        Throws:
        DTDException - if the input DTD Element Declaration is malformed.
        SchemaException - if unable to construct return ElementDecl object from the input DTD Element object.

      • convertAttribute

        public AttributeDecl convertAttribute​(Attribute dtdAttribute,
                                      Schema schema)
                               throws DTDException
        Convert DTD Attribute declaration to Schema Attribute Declaration.
        Parameters:
        dtdAttribute - DTD Attribute declaration.
        schema - Schema owning Element of this Attribute.
        Returns:
        corresponding Schema Attribute declaration.
        Throws:
        DTDException - if the input DTD Attribute Declaration is malformed.

      • marshalSchema

        public void marshalSchema​(Schema schema,
                          java.io.Writer writer)
                   throws java.io.IOException,
                          org.xml.sax.SAXException
        Marshals XML Schema to output char stream.
        Parameters:
        schema - XML Schema object to marshal.
        writer - output char stream to marshal Schema to.
        Throws:
        java.io.IOException - if there is an I/O problem with the writer.
        org.xml.sax.SAXException - if an error occured during schema marshalling.