com.ibm.commerce.member.search

Class TableField

  • java.lang.Object
    • com.ibm.commerce.member.search.TableField
  • All Implemented Interfaces:
    java.io.Serializable

    public class TableField
extends java.lang.Object
implements java.io.Serializable
    TableField. A simple helper class representing a Table/Field combination.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM Copyright

    • Constructor Summary

      Constructors 
      Constructor and Description
      TableField(java.lang.String astrTableName, java.lang.String astrFieldName)
      Default constructor.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      static java.lang.String formatTableFieldName(java.lang.String astrTableFieldName)
      Format the table or field name.
      java.lang.String getFieldName()
      Get the field name.
      java.lang.String getTableName()
      Get the table name.
      boolean isValid()
      Returns whether or not the object is valid.
      void setFieldName(java.lang.String aIstrFieldName)
      Set the field name.
      void setTableName(java.lang.String astrTableName)
      Set the table name.
      java.lang.String toString()
      Convert the object toString().

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM Copyright
        See Also:
        Constant Field Values

    • Constructor Detail

      • TableField

        public TableField(java.lang.String astrTableName,
                  java.lang.String astrFieldName)
        Default constructor.
        Parameters:
        astrTableName - The table name.
        astrFieldName - The field name.

    • Method Detail

      • formatTableFieldName

        public static java.lang.String formatTableFieldName(java.lang.String astrTableFieldName)
        Format the table or field name. If the string is empty or null, will return null. Otherwise, will trim then convert to upper case.
        Parameters:
        astrTableFieldName - The table or field name to convert.
        Returns:
        The formatted table or field name; null if the input was null or an empty string.

      • getFieldName

        public java.lang.String getFieldName()
        Get the field name.
        Returns:
        String The field name.

      • setFieldName

        public void setFieldName(java.lang.String aIstrFieldName)
        Set the field name.
        Parameters:
        The - field name.

      • getTableName

        public java.lang.String getTableName()
        Get the table name.
        Returns:
        String The table name.

      • setTableName

        public void setTableName(java.lang.String astrTableName)
        Set the table name.
        Parameters:
        astrTableName - The table name.

      • isValid

        public boolean isValid()
        Returns whether or not the object is valid. A valid TableField object has non-null and non-empty table and field names.
        Returns:
        true if the object is valid; false otherwise

      • toString

        public java.lang.String toString()
        Convert the object toString(). Returns format "TABLE.FIELD"
        Overrides:
        toString in class java.lang.Object
        Returns:
        String Returns the table and field names in the format "TABLENAME.FIELDNAME"
Skip navigation links