Class SortHintHandle


  • public class SortHintHandle
    extends StructureHandle
    This class represents sort hint handle.
    • Constructor Detail

      • SortHintHandle

        public SortHintHandle​(SimpleValueHandle valueHandle,
                              int index)
        Parameters:
        valueHandle - the value handle for computed column list of one property
        index - the position in the list.
    • Method Detail

      • getColumnName

        public java.lang.String getColumnName()
        Gets the column name.
        Returns:
        the column name.
      • setColumnName

        public void setColumnName​(java.lang.String columnName)
                           throws SemanticException
        Sets the column Name.
        Parameters:
        columnName - the column name.
        Throws:
        SemanticException
      • getPosition

        public int getPosition()
        Gets the index position of a result set column.
        Returns:
        the index position of a result set column.
      • setPosition

        public void setPosition​(int position)
                         throws SemanticException
        Sets the index position of a result set column.
        Parameters:
        position - the index position of a result set column.
        Throws:
        SemanticException
      • getDirection

        public java.lang.String getDirection()
        Gets the sort direction of this result set column. The possible values are define in DesignChoiceConstants, and they are:
        • SORT_DIRECTION_ASC
        • SORT_DIRECTION_DESC
        Returns:
        the sort direction of this result set column.
      • setDirection

        public void setDirection​(java.lang.String direction)
                          throws SemanticException
        Sets the direction value. It indicates the sort direction of this result set column. The possible values are define in DesignChoiceConstants, and they are:
        • SORT_DIRECTION_ASC
        • SORT_DIRECTION_DESC
        Parameters:
        direction - the sort direction of this result set column.
        Throws:
        SemanticException
      • getNullValueOrdering

        public java.lang.String getNullValueOrdering()
        Gets the null value ordering. It indicates the ordering of null vs. non-null values in the sort order. The possible values are define in DesignChoiceConstants, and they are:
        • NULL_VALUE_ORDERING_TYPE_UNKNOWN
        • NULL_VALUE_ORDERING_TYPE_NULLISFIRST
        • NULL_VALUE_ORDERING_TYPE_NULLISLAST
        Returns:
        the null value ordering.
      • setNullValueOrdering

        public void setNullValueOrdering​(java.lang.String nullValueOrdering)
                                  throws SemanticException
        Sets the null value ordering. It indicates the ordering of null vs. non-null values in the sort order. The possible values are define in DesignChoiceConstants, and they are:
        • NULL_VALUE_ORDERING_TYPE_UNKNOWN
        • NULL_VALUE_ORDERING_TYPE_NULLISFIRST
        • NULL_VALUE_ORDERING_TYPE_NULLISLAST
        Parameters:
        nullValueOrdering - the null value ordering.
        Throws:
        SemanticException
      • isOptional

        public boolean isOptional()
        Indicates whether this sort key can be excluded at runtime.
        Returns:
        if this sort key can be excluded at runtime, otherwise return .
      • setOptional

        public void setOptional​(boolean isOptional)
        Sets the isOptional value.
        Parameters:
        isOptional - if this sort key can be excluded at runtime, otherwise return .