AttributeInfo

java.lang.Object
- com.ibm.commerce.search.base.AttributeInfo

Direct Known Subclasses:

AttributeAttributeIdentifierAttributeInfo, AttributeCatEntIdentifierAttributeInfo, AttributeLanguageIdentifierAttributeInfo, AttributeNameAttributeInfo, AttrValueAttributeIdentifierAttributeInfo, AttrValueCatEntIdentifierAttributeInfo, AttrValueFloatValueAttributeInfo, AttrValueGenericAttributeInfo, AttrValueIntegerValueAttributeInfo, AttrValueLanguageIdentifierAttributeInfo, AttrValueNameAttributeInfo, AttrValueStringValueAttributeInfo, CatalogDescAttributeInfo, CatalogDescCatalogIdAttributeInfo, CatalogDescLanguageIdAttributeInfo, CatalogDescNameAttributeInfo, CatalogDescriptionAttributeInfo, CatalogDescShortDescAttributeInfo, CatalogIdentAttributeInfo, CatalogIdentifierAttributeInfo, CatEntDescAvailabilityDateAttributeInfo, CatEntDescAvailableAttributeInfo, CatEntDescCatEntIdentifierAttributeInfo, CatEntDescIdentifierAttributeInfo, CatEntDescKeywordAttributeInfo, CatEntDescLanguageIdentifierAttributeInfo, CatEntDescLongDescAttributeInfo, CatEntDescNameAttributeInfo, CatEntDescPartnumberAttributeInfo, CatEntDescPublishedAttributeInfo, CatEntDescShortDescAttributeInfo, CatEntDescThumbnailAttributeInfo, CatEntRelChildIdentifierAttributeInfo, CatEntRelParentIdentifierAttributeInfo, CatEntRelTypeAttributeInfo, CatEntryBuyableAttributeInfo, CatEntryField1AttributeInfo, CatEntryField2AttributeInfo, CatEntryField3AttributeInfo, CatEntryField4AttributeInfo, CatEntryField5AttributeInfo, CatEntryIdentifierAttributeInfo, CatEntryItemSpcIdentifierAttributeInfo, CatEntryLastUpdateAttributeInfo, CatEntryMarkfordeleteAttributeInfo, CatEntryMfnameAttributeInfo, CatEntryMFPartnumberAttributeInfo, CatEntryOnAuctionAttributeInfo, CatEntryOnSpecialAttributeInfo, CatEntryPartnumberAttributeInfo, CatEntrySKUAttributeInfo, CatEntryTypeAttributeInfo, CatGpEnRelCatalogIdentifierAttributeInfo, CatGpEnRelCatEntIdentifierAttributeInfo, CatGpEnRelCatGpIdentifierAttributeInfo, CatGroupIdentAttributeInfo, CatGroupIdentifierAttributeInfo, CatGroupLastupdateAttributeInfo, CatGroupMarkfordeleteAttributeInfo, CatGrpDescIdentifierAttributeInfo, CatGrpDescKeywordAttributeInfo, CatGrpDescLanguageIdentifierAttributeInfo, CatGrpDescLongDescAttributeInfo, CatGrpDescNameAttributeInfo, CatGrpDescPublishedAttributeInfo, CatGrpDescShortDescAttributeInfo, CatGrpRelCatalogIdAttributeInfo, CatGrpRelChildCatalogIdAttributeInfo, CatGrpRelParentCatalogIdAttributeInfo, CattoGrpCatalogIdAttributeInfo, CattoGrpCatGroupIdAttributeInfo, CollateralField1AttributeInfo, CollateralField2AttributeInfo, CollateralIDAttributeInfo, CollateralNameAttributeInfo, CollateralStoreAttributeInfo, CollateralTypeIDAttributeInfo, CollateralURLAttributeInfo, CollDescField1AttributeInfo, CollDescField2AttributeInfo, CollDescFileNameAttributeInfo, CollDescIDAttributeInfo, CollDescLanguageAttributeInfo, CollDescMktTxtAttributeInfo, CollTypeIDAttributeInfo, CollTypeNameAttributeInfo, DispEntRelCatEntIdentifierAttributeInfo, DispEntRelGroupIdentifierAttributeInfo, DispEntRelStoreIdentifierAttributeInfo, InventoryQuantityAttributeInfo, InventoryQuantityMeasureAttributeInfo, InvStVwItemSpcIdentifierAttributeInfo, InvStVwQuanMeasureAttributeInfo, InvStVwQuantityAvailableAttributeInfo, InvStVwStoreIdentifierAttributeInfo, ListPriceAttributeInfo, ListPriceCatEntIdentifierAttributeInfo, ListPriceCurrencyAttributeInfo, MbrGrpMbrGrpIdentifierAttributeInfo, MbrGrpMbrIdentifierAttributeInfo, OfferCatentryIdAttributeInfo, OfferMaxQuantityAttributeInfo, OfferMinQuantityAttributeInfo, OfferOfferIdAttributeInfo, OfferPriceCurrencyAttributeInfo, OfferPriceOfferIdAttributeInfo, OfferPricePriceAttributeInfo, OfferTradeposcnIdAttributeInfo, PrsetcerelCatEntIdentifierAttributeInfo, PrsetcerelProductsetIdAttributeInfo, StdPriceVwCatentryIdAttributeInfo, StdPriceVwCurrencyAttributeInfo, StdPriceVwPriceAttributeInfo, StoreCatCatalogIdentifierAttributeInfo, StoreCatMastercatalogAttributeInfo, StoreCatStoreIdentifierAttributeInfo, StoreCEntIdentifierAttributeInfo, StoreCEntStoreIdentifierAttributeInfo, StoreCGrpCatGroupIdAttributeInfo, StoreCGrpStoreEntIdAttributeInfo, StoreInvCatEntIdentifierAttributeInfo, StoreInvQuanMeasureAttributeInfo, StoreInvQuantityAttributeInfo, StoreMbrGpIdentifierAttributeInfo, StoreMbrGpStoreIdentifierAttributeInfo, TradeposcnTradeposcnIdAttributeInfo, TradeposcnTypeAttributeInfo, UsersIdentifierAttributeInfo
```
public abstract class AttributeInfo
extends java.lang.Object
```
Classes derived from this abstract class encapsulate information about a mapping from a database table column to an attribute Java object.
Through this class you can gain information such as the column name, and data type. A table info class can be used to add table information to the attribute info class.
See direct known subclasses for more specific examples.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`columnName` The name of this column.
`protected boolean`	`enabled` Indicates whether this column is enabled.
`protected java.lang.String`	`propertyName` Reserved for IBM internal use.
`protected java.lang.String`	`queryString` Reserved for IBM internal use.
`protected AttributeInfo`	`referto` Reserved for IBM internal use.
`protected int`	`scale` Reserved for IBM internal use.
`protected int`	`sqltype` The data type to be used in generating SQL queries.
`static int`	`SQLTYPE_CHAR` The `CHAR` data type.
`static int`	`SQLTYPE_NUM` The `NUMERIC` data type.
`static int`	`SQLTYPE_TIME` The `TIME` data type.
`java.lang.String`	`tableName` The name of this table.
`protected java.lang.Class`	`type` Reserved for IBM internal use.

Constructor Summary

Constructors
Constructor and Description
`AttributeInfo()` The default constructor.
`AttributeInfo(java.lang.String propertyName, int sqltype, java.lang.String columnName)` Reserved for IBM internal use.
`AttributeInfo(java.lang.String propertyName, int sqltype, java.lang.String columnName, java.lang.Class type)` Reserved for IBM internal use.
`AttributeInfo(java.lang.String propertyName, int sqltype, java.lang.String columnName, java.lang.Class type, int scale)` Reserved for IBM internal use.
`AttributeInfo(java.lang.String propertyName, int sqltype, java.lang.String columnName, java.lang.String queryString)` Reserved for IBM internal use.
`AttributeInfo(java.lang.String propertyName, int sqltype, java.lang.String columnName, java.lang.String queryString, java.lang.Class type)` Reserved for IBM internal use.
`AttributeInfo(java.lang.String propertyName, int sqltype, java.lang.String columnName, java.lang.String queryString, java.lang.Class type, int scale)` Reserved for IBM internal use.
`AttributeInfo(TableInfo info)` The constructor with the table information supplied.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getColumnName()` Gets the name of this column.
`java.lang.String`	`getPropertyName()` Reserved for IBM internal use.
`java.lang.String`	`getQueryString()` Reserved for IBM internal use.
`AttributeInfo`	`getReferTo()` Reserved for IBM internal use.
`int`	`getScale()` Reserved for IBM internal use.
`int`	`getSQLType()` Gets the data type to be used in generating SQL queries for this column.
`TableInfo`	`getTableInfo()` Gets this table's information.
`java.lang.String`	`getTableName()` Gets this table's name.
`java.lang.Class`	`getType()` Reserved for IBM internal use.
`boolean`	`isEnabled()` Checks whether this column is enabled.
`void`	`setEnabled(boolean flag)` Sets whether this column is enabled for this table.
`void`	`setQueryString(java.lang.String val)` Reserved for IBM internal use.
`void`	`setReferTo(AttributeInfo f)` Reserved for IBM internal use.
`void`	`setScale(int scale)` Reserved for IBM internal use.
`void`	`setTableInfo(TableInfo a)` Sets this table's information.
`void`	`setTableName(java.lang.String newTableName)` Sets this table's name.
`java.lang.String`	`toString()` Converts this object to a string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SQLTYPE_NUM
```
public static final int SQLTYPE_NUM
```
    The NUMERIC data type.
    
    See Also:
    
    Constant Field Values
  - SQLTYPE_CHAR
```
public static final int SQLTYPE_CHAR
```
    The CHAR data type.
    
    See Also:
    
    Constant Field Values
  - SQLTYPE_TIME
```
public static final int SQLTYPE_TIME
```
    The TIME data type.
    
    See Also:
    
    Constant Field Values
  - propertyName
```
protected java.lang.String propertyName
```
    Reserved for IBM internal use.
  - columnName
```
protected java.lang.String columnName
```
    The name of this column.
  - queryString
```
protected java.lang.String queryString
```
    Reserved for IBM internal use.
  - scale
```
protected int scale
```
    Reserved for IBM internal use.
  - sqltype
```
protected int sqltype
```
    The data type to be used in generating SQL queries.
  - type
```
protected java.lang.Class type
```
    Reserved for IBM internal use.
  - enabled
```
protected boolean enabled
```
    Indicates whether this column is enabled. This flag is useful for columns that only exist for certain version of the database schema.
  - tableName
```
public java.lang.String tableName
```
    The name of this table.
  - referto
```
protected AttributeInfo referto
```
    Reserved for IBM internal use.
- Constructor Detail
  - AttributeInfo
```
public AttributeInfo()
```
    The default constructor.
  - AttributeInfo
```
public AttributeInfo(TableInfo info)
```
    The constructor with the table information supplied.
    
    Parameters:
    
    info - the table information
  - AttributeInfo
```
public AttributeInfo(java.lang.String propertyName,
             int sqltype,
             java.lang.String columnName)
```
    Reserved for IBM internal use.
    
    Parameters:
    
    propertyName - the property that the column is mapped to
    
    sqltype - the data type
    
    columnName - the column name
  - AttributeInfo
```
public AttributeInfo(java.lang.String propertyName,
             int sqltype,
             java.lang.String columnName,
             java.lang.Class type)
```
    Reserved for IBM internal use.
    
    Parameters:
    
    propertyName - the property that the column is mapped to
    
    sqltype - the data type
    
    columnName - the column name
    
    type - the type
  - AttributeInfo
```
public AttributeInfo(java.lang.String propertyName,
             int sqltype,
             java.lang.String columnName,
             java.lang.Class type,
             int scale)
```
    Reserved for IBM internal use.
    
    Parameters:
    
    propertyName - the property that the column is mapped to
    
    sqltype - the data type
    
    columnName - the column name
    
    type - the type
    
    scale - the scale
  - AttributeInfo
```
public AttributeInfo(java.lang.String propertyName,
             int sqltype,
             java.lang.String columnName,
             java.lang.String queryString)
```
    Reserved for IBM internal use.
    
    Parameters:
    
    propertyName - the property that the column is mapped to
    
    sqltype - the data type
    
    columnName - the column name
    
    queryString - the query string
  - AttributeInfo
```
public AttributeInfo(java.lang.String propertyName,
             int sqltype,
             java.lang.String columnName,
             java.lang.String queryString,
             java.lang.Class type)
```
    Reserved for IBM internal use.
    
    Parameters:
    
    propertyName - the property that the column is mapped to
    
    sqltype - the data type
    
    columnName - the column name
    
    queryString - the query string
    
    type - the Java type mapping
  - AttributeInfo
```
public AttributeInfo(java.lang.String propertyName,
             int sqltype,
             java.lang.String columnName,
             java.lang.String queryString,
             java.lang.Class type,
             int scale)
```
    Reserved for IBM internal use.
    
    Parameters:
    
    propertyName - the property that the column is mapped to
    
    sqltype - the data type
    
    columnName - the name of the column
    
    type - the Java type mapping
    
    scale - the column scale for NUMERIC and DECIMAL data types
- Method Detail
  - getColumnName
```
public final java.lang.String getColumnName()
```
    Gets the name of this column.
    
    Returns:
    
    name of the column
  - getPropertyName
```
public final java.lang.String getPropertyName()
```
    Reserved for IBM internal use.
    
    Returns:
    
    property name
  - getQueryString
```
public final java.lang.String getQueryString()
```
    Reserved for IBM internal use.
    
    Returns:
    
    query string
  - getReferTo
```
public AttributeInfo getReferTo()
```
    Reserved for IBM internal use.
    
    Returns:
    
    the AttributeInfo object
  - getScale
```
public final int getScale()
```
    Reserved for IBM internal use.
    
    Returns:
    
    the scale
  - getSQLType
```
public final int getSQLType()
```
    Gets the data type to be used in generating SQL queries for this column.
    
    Returns:
    
    the data type
  - getTableInfo
```
public TableInfo getTableInfo()
```
    Gets this table's information.
    
    Returns:
    
    the table information
  - getTableName
```
public java.lang.String getTableName()
```
    Gets this table's name.
    
    Returns:
    
    the table name
  - getType
```
public final java.lang.Class getType()
```
    Reserved for IBM internal use.
    
    Returns:
    
    the Java type
  - isEnabled
```
public final boolean isEnabled()
```
    Checks whether this column is enabled.
    
    Returns:
    
    true if the column is enabled; false otherwise
    
    See Also:
    
    enabled
  - setEnabled
```
public final void setEnabled(boolean flag)
```
    Sets whether this column is enabled for this table.
    
    Parameters:
    
    true - if the column is enabled; false otherwise
    
    See Also:
    
    enabled
  - setQueryString
```
public final void setQueryString(java.lang.String val)
```
    Reserved for IBM internal use.
    
    Parameters:
    
    val - the query string
  - setReferTo
```
public void setReferTo(AttributeInfo f)
```
    Reserved for IBM internal use.
    
    Parameters:
    
    f - the AttributeInfo object
  - setScale
```
public final void setScale(int scale)
```
    Reserved for IBM internal use.
    
    Parameters:
    
    scale - scale for this attribute
  - setTableInfo
```
public void setTableInfo(TableInfo a)
```
    Sets this table's information.
    
    Parameters:
    
    a - the table information
  - setTableName
```
public void setTableName(java.lang.String newTableName)
```
    Sets this table's name.
    
    Parameters:
    
    newTableName - the table name
  - toString
```
public java.lang.String toString()
```
    Converts this object to a string.
    
    Overrides:
    
    toString in class java.lang.Object

Class AttributeInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SQLTYPE_NUM

SQLTYPE_CHAR

SQLTYPE_TIME

propertyName

columnName

queryString

scale

sqltype

type

enabled

tableName

referto

Constructor Detail

AttributeInfo

AttributeInfo

AttributeInfo

AttributeInfo

AttributeInfo

AttributeInfo

AttributeInfo

AttributeInfo

Method Detail

getColumnName

getPropertyName

getQueryString

getReferTo

getScale

getSQLType

getTableInfo

getTableName

getType

isEnabled

setEnabled

setQueryString

setReferTo

setScale

setTableInfo

setTableName

toString