Package io.deephaven.enterprise.schema.xml

Interface SchemaXmlParser

All Known Subinterfaces:
LegacySchemaXmlParser
All Known Implementing Classes:
LegacySchemaXmlParser.LegacyParser, SchemaXmlParser.StandardParser
public interface SchemaXmlParser
Interface for parsing XML schema Elements.

  • Method Details

    • getRequiredAttribute

      @NotNull static String getRequiredAttribute(@NotNull org.jdom2.Element element, @NotNull String attributeName)
      Get an attribute, throwing a SchemaException if it is not set.
      Parameters:
      element - the Element containing attributes
      attributeName - name of the attribute to fetch
      Returns:
      the String value of the attribute
      Throws:
      SchemaException - if the attribute is not set

    • getRequiredInteger

      static int getRequiredInteger(@NotNull org.jdom2.Element element, @NotNull String attributeName)
      Get an integer attribute, throwing a SchemaException if it is not set.
      Parameters:
      element - the Element containing attributes
      attributeName - name of the attribute to fetch
      Returns:
      the integer value of the attribute
      Throws:
      SchemaException - if the attribute is not set

    • getOptionalString

      @NotNull static String getOptionalString(@NotNull org.jdom2.Element element, @NotNull String attributeName, @NotNull String defaultValue)
      Get an attribute, returning a default value if not set.
      Parameters:
      element - the Element containing attributes
      attributeName - name of the attribute to fetch
      defaultValue - the value to return if the attribute is not present
      Returns:
      the String value of the attribute

    • getOptionalBoolean

      @NotNull static Optional<Boolean> getOptionalBoolean(@NotNull org.jdom2.Element element, @NotNull String attributeName)
      Get an attribute, throwing a SchemaException if it is not a valid boolean.
      Parameters:
      element - the Element containing attributes
      attributeName - name of the attribute to fetch
      Returns:
      the value of the attribute, or empty
      Throws:
      SchemaException - if the attribute is not a valid boolean

    • getOptionalInteger

      @NotNull static OptionalInt getOptionalInteger(@NotNull org.jdom2.Element element, @NotNull String attributeName)
      Get an attribute, throwing a SchemaException if it is not a valid integer.
      Parameters:
      element - the Element containing attributes
      attributeName - name of the attribute to fetch
      Returns:
      the value of the attribute, or empty
      Throws:
      SchemaException - if the attribute is not a valid boolean

    • getNamespace

      @NotNull String getNamespace()

    • getTableName

      @NotNull String getTableName()

    • getDefaultMergeFormat

      @NotNull Database.StorageFormat getDefaultMergeFormat() throws SchemaValidationException
      Throws:
      SchemaValidationException

    • getMergeCodecName

      @Nullable String getMergeCodecName(@NotNull String mergeFormat) throws SchemaValidationException
      Throws:
      SchemaValidationException

    • getStorageType

      @Nullable Integer getStorageType()

    • getPartitionKeyFormula

      @Nullable String getPartitionKeyFormula()

    • getLoggers

      @NotNull List<LoggerXmlImpl> getLoggers()

    • getV2Loggers

      @NotNull List<V2Logger> getV2Loggers()

    • getListeners

      @NotNull List<ListenerXmlImpl> getListeners()

    • getLoggerListeners

      @NotNull List<LoggerListenerXmlImpl> getLoggerListeners()

    • getImportSources

      @NotNull List<ImportSourceXmlImpl> getImportSources()

    • getValidator

      @Nullable Validator getValidator()

    • validate

      @NotNull List<SchemaValidationException> validate(boolean lenientValidation) throws SchemaValidationException
      Validate the XML in the element, throw an exception if any errors are found.
      Parameters:
      lenientValidation - if true, ClassNotFoundExceptions will be ignored when validating
      Returns:
      SchemaValidationExceptions list of exceptions that were ignored because lenientValidation==true
      Throws:
      SchemaValidationException - if any errors are found validating

    • getDataIndexSets

      List<String[]> getDataIndexSets()

    • getExtendedStorage

      @Nullable ExtendedStorageXml getExtendedStorage()

    • getInputTableStateSpec

      @Nullable InputTableStateSpec getInputTableStateSpec()