Package io.deephaven.importers

Class StandardImporterArguments

java.lang.Object
io.deephaven.importers.StandardImporterArguments
All Implemented Interfaces:
LogOutputAppendable
public class StandardImporterArguments extends Object
Standard class for importer arguments. Extends StandardArguments to add arguments and capabilities needed for data import.

  • Field Details

    • namespace

      protected final String namespace

    • tableName

      protected final String tableName

  • Constructor Details

    • StandardImporterArguments

      protected StandardImporterArguments(@NotNull @NotNull io.deephaven.shadow.enterprise.org.apache.commons.cli.CommandLine commandLine) throws io.deephaven.shadow.enterprise.org.apache.commons.cli.ParseException
      Throws:
      io.deephaven.shadow.enterprise.org.apache.commons.cli.ParseException

    • StandardImporterArguments

      protected StandardImporterArguments(@NotNull @NotNull String namespace, @NotNull @NotNull String tableName, @Nullable @Nullable String destinationPartitionStr, @Nullable @Nullable File destinationDirectory, @Nullable @Nullable String partitioningColumn, @NotNull @NotNull ImportOutputMode outputMode)

  • Method Details

    • getPartitioningColumnName

      public String getPartitioningColumnName()

    • getDestinationPartitions

      public String[] getDestinationPartitions()

    • getDestinationDirectory

      public File getDestinationDirectory()

    • getImportTableWriterFactory

      public ImportTableWriterFactory getImportTableWriterFactory()

    • appendArguments

      public LogOutput appendArguments(@NotNull @NotNull LogOutput logOutput)
      Subclasses should define their own version of appendArguments, which should almost always invoke the super-class implementation first.
      Parameters:
      logOutput - A LogOutput to append argument names and values to.
      Returns:
      The logOutput

    • parseCommandLine

      @SafeVarargs protected static <AT extends io.deephaven.importers.StandardArguments> AT parseCommandLine(@NotNull @NotNull String importerName, @NotNull @NotNull io.deephaven.importers.StandardArguments.ArgumentsConstructor<AT> argumentsConstructor, @NotNull @NotNull String[] commandLineArguments, @NotNull @NotNull UnaryOperator<io.deephaven.shadow.enterprise.org.apache.commons.cli.Options>... extraOptionSuppliers)

    • getHelpString

      @SafeVarargs public static String getHelpString(@NotNull @NotNull String importerName, @NotNull @NotNull UnaryOperator<io.deephaven.shadow.enterprise.org.apache.commons.cli.Options>... extraOptionSuppliers)
      Construct a help string based on the standard arguments and those of an extending class.
      Parameters:
      importerName - The name of the importer implementation class
      extraOptionSuppliers - options supplied by extension of StandardImporterArguments.
      Returns:
      a string documenting the expected command line arguments

    • main

      public static void main(String... args)
      Entry point for execution in testing.
      Parameters:
      args - command line

    • append

      public final LogOutput append(LogOutput logOutput)
      Specified by:
      append in interface LogOutputAppendable

    • toString

      public String toString()
      Overrides:
      toString in class Object