Package io.keikai.axyra.sheets.content

Record Class DataConnection

java.lang.Object
java.lang.Record
io.keikai.axyra.sheets.content.DataConnection
public record DataConnection(int id, String name, String kind, String command, String connectionString) extends Record
A data connection (Power Query or other) read from a workbook's xl/connections.xml: its id, display name, source kind, command text and connection string.

kind is one of "oledb", "odbc", "web", "text", "file", "dao" or "other". Command text and connection string are editable through Workbook.setConnectionCommand(java.lang.String, java.lang.String) / Workbook.setConnectionString(java.lang.String, java.lang.String); the rest of the connections part is preserved byte-exact.

Read with Workbook.connections(), which returns snapshots. The setters address a connection by name().

  • Constructor Summary

    Constructors
    Constructor
    Description
    DataConnection(int id, String name, String kind, String command, String connectionString)
    Creates an instance of a DataConnection record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    command()
    Returns the value of the command record component.
    String
    connectionString()
    Returns the value of the connectionString record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static DataConnection
    fromMap(Map<String,Object> m)
    Builds a DataConnection from a decoded JSON object.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    id()
    Returns the value of the id record component.
    String
    kind()
    Returns the value of the kind record component.
    String
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • DataConnection

      public DataConnection(int id, String name, String kind, String command, String connectionString)
      Creates an instance of a DataConnection record class.
      Parameters:
      id - the value for the id record component
      name - the value for the name record component
      kind - the value for the kind record component
      command - the value for the command record component
      connectionString - the value for the connectionString record component

  • Method Details

    • fromMap

      public static DataConnection fromMap(Map<String,Object> m)
      Builds a DataConnection from a decoded JSON object.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • id

      public int id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • kind

      public String kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component

    • command

      public String command()
      Returns the value of the command record component.
      Returns:
      the value of the command record component

    • connectionString

      public String connectionString()
      Returns the value of the connectionString record component.
      Returns:
      the value of the connectionString record component