Package com.altova.raptorxml

Interface RaptorXMLFactory

public interface RaptorXMLFactory

  • Method Details

    • getXMLValidator

      XMLValidator getXMLValidator()
      Retrieve the XML Validator.
      Returns:
      a new XML Validator instance

    • getXBRL

      XBRL getXBRL()
      Retrieve the XBRL engine
      Returns:
      a new XBRL instance

    • getXQuery

      XQuery getXQuery()
      Retrieve the XQuery engine
      Returns:
      a new XQuery instance

    • getXSLT

      XSLT getXSLT()
      Retrieve the XQuery engine
      Returns:
      a new XQuery instance

    • getXMLDsig

      XMLDsig getXMLDsig()
      Retrieve the XMLDsig engine
      Returns:
      a new XMLDsig instance

    • setServerName

      void setServerName(String name) throws RaptorXMLException
      Sets the server name for the HTTP server
      Parameters:
      name - Server machine
      Throws:
      RaptorXMLException

    • setServerFile

      void setServerFile(String file) throws RaptorXMLException
      Sets the server internal address for the HTTP server
      Parameters:
      file - Server address, relative to the HTTP server's root
      Throws:
      RaptorXMLException

    • setServerPort

      void setServerPort(int port) throws RaptorXMLException
      Sets the HTTP server's port
      Parameters:
      port - Server port number
      Throws:
      RaptorXMLException

    • setUserCatalog

      void setUserCatalog(String catalog)
      Set the file name for an additional catalog. Please note that you have to use absolute URLs.
      Parameters:
      catalog - an absolute URL giving the base location of the file

    • setGlobalCatalog

      void setGlobalCatalog(String catalog)
      Set the file name for the global catalog. Please note that you have to use absolute URLs.
      Parameters:
      catalog - an absolute URL giving the base location of the file

    • setGlobalResourcesFile

      void setGlobalResourcesFile(String file)
      Set the file name for the global resources file. Please note that you have to use absolute URLs.
      Parameters:
      file - an absolute URL giving the base location of the file.

    • setGlobalResourceConfig

      void setGlobalResourceConfig(String config)
      Set the active global resource configuration.
      Parameters:
      config - Name of the configuration.

    • setErrorLimit

      void setErrorLimit(int limit) throws RaptorXMLException
      Configure the engine's Error Limit property
      Parameters:
      limit - Number of errors to report before stopping; allowed values: 1-999
      Throws:
      RaptorXMLException

    • setReportOptionalWarnings

      void setReportOptionalWarnings(boolean report)
      Enable/disable warning reporting
      Parameters:
      report - New value

    • setErrorFormat

      void setErrorFormat(RaptorXMLFactory.ENUMErrorFormat format)
      Configure the format of reported errors
      Parameters:
      format - Error format: text, short XML or long XML (default: text)

    • getMajorVersion

      int getMajorVersion() throws RaptorXMLException
      Returns the major version of the product; e.g. returns 16 for Altova RaptorXML+XBRL Server 2014 r2 sp1 (x64)
      Throws:
      RaptorXMLException

    • getMinorVersion

      int getMinorVersion() throws RaptorXMLException
      Returns the minor version of the product; e.g. returns 2 for Altova RaptorXML+XBRL Server 2014 r2 sp1 (x64)
      Throws:
      RaptorXMLException

    • getServicePackVersion

      int getServicePackVersion() throws RaptorXMLException
      Returns the service pack version of the product; e.g. returns 1 for Altova RaptorXML+XBRL Server 2014 r2 sp1 (x64)
      Throws:
      RaptorXMLException

    • getProductName

      String getProductName() throws RaptorXMLException
      Returns the name of the product; e.g. returns "Altova RaptorXML+XBRL Server" for Altova RaptorXML+XBRL Server 2014 r2 sp1 (x64)
      Throws:
      RaptorXMLException

    • is64bit

      boolean is64bit() throws RaptorXMLException
      Checks if the engine is a 64-bit executable; e.g. returns true for Altova RaptorXML+XBRL Server 2014 r2 sp1 (x64)
      Throws:
      RaptorXMLException

    • getProductNameAndVersion

      String getProductNameAndVersion() throws RaptorXMLException
      Returns the complete name and version number of the product; e.g. "Altova RaptorXML+XBRL Server 2014 r2 sp1 (x64)"
      Throws:
      RaptorXMLException

    • getAPIMajorVersion

      int getAPIMajorVersion()
      Returns the major version of the API; could be different from the product's version if the API is connected to another server

    • getAPIMinorVersion

      int getAPIMinorVersion()
      Returns the minor version of the API; could be different from the product's version if the API is connected to another server

    • getAPIServicePackVersion

      int getAPIServicePackVersion()
      Returns the service pack version of the API; could be different from the product's version if the API is connected to another server