Package com.snowflake.snowpark_java.types

Class ColumnIdentifier

  • All Implemented Interfaces:
    java.lang.Cloneable
    public class ColumnIdentifier
extends java.lang.Object
implements java.lang.Cloneable
    Represents Column Identifier
    Since:
    0.9.0

    • Constructor Summary

      Constructors 
      Constructor Description
      ColumnIdentifier​(java.lang.String name)
      Creates a ColumnIdentifier object for the giving column name.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ColumnIdentifier clone()
      Creates a clone of this ColumnIdentifier object.
      boolean equals​(java.lang.Object other)
      Compares this ColumnIdentifier with the giving one
      int hashCode()
      Calculates the hash code of this ColumnIdentifier.
      java.lang.String name()
      Returns the name of column.
      java.lang.String quotedName()
      Returns the quoted name of this column Name Format: 1.
      java.lang.String toString()
      Generates a String value to represent this Column Identifier.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ColumnIdentifier

        public ColumnIdentifier​(java.lang.String name)
        Creates a ColumnIdentifier object for the giving column name. Identifier Requirement can be found from https://docs.snowflake.com/en/sql-reference/identifiers-syntax.html
        Parameters:
        name - The column name
        Since:
        0.9.0

    • Method Detail

      • name

        public java.lang.String name()
        Returns the name of column. Name format: 1. if the name quoted. a. starts with _A-Z and follows by _A-Z0-9$: remove quotes b. starts with $ and follows by digits: remove quotes c. otherwise, do nothing 2. if not quoted. a. starts with _a-zA-Z and follows by _a-zA-Z0-9$, upper case all letters. b. starts with $ and follows by digits, do nothing c. otherwise, quote name

        More details can be found from https://docs.snowflake.com/en/sql-reference/identifiers-syntax.html

        Returns:
        A String value representing the name
        Since:
        0.9.0

      • quotedName

        public java.lang.String quotedName()
        Returns the quoted name of this column Name Format: 1. if quoted, do nothing 2. if not quoted. a. starts with _a-zA-Z and follows by _a-zA-Z0-9$, upper case all letters and then quote b. otherwise, quote name

        It is same as [[name]], but quotes always added. It is always safe to do String comparisons between quoted column names

        Returns:
        A String value representing the quoted name
        Since:
        0.9.0

      • equals

        public boolean equals​(java.lang.Object other)
        Compares this ColumnIdentifier with the giving one
        Overrides:
        equals in class java.lang.Object
        Returns:
        true if these two are equivalent, otherwise, returns false.
        Since:
        0.9.0

      • hashCode

        public int hashCode()
        Calculates the hash code of this ColumnIdentifier.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        An int number representing the hash code value
        Since:
        0.9.0

      • toString

        public java.lang.String toString()
        Generates a String value to represent this Column Identifier.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A String value
        Since:
        0.9.0

      • clone

        public ColumnIdentifier clone()
        Creates a clone of this ColumnIdentifier object.
        Overrides:
        clone in class java.lang.Object
        Returns:
        A new ColumnIdentifier object
        Since:
        1.2.0