IBM WebSphere Extended Deployment (XD)TM, Release 6.1
ObjectGrid API Specification

com.ibm.websphere.objectgrid.streamquery
Interface StreamQueryMetadata

All Known Subinterfaces:
StreamMetadata, ViewMetadata

public interface StreamQueryMetadata

A common parent interface for ViewMetadata and StreamMetadata.

Since:
WAS XD 6.1
See Also:
AccessType

Method Summary
 AccessType getAccessType()
          Get the access type.
 java.lang.String getMapName()
          return the ObjectGrid map name of the map that contains the data for this view or stream
 java.lang.String getName()
          return the name of the stream or view
 java.lang.String getObjectGridName()
          return the ObjectGrid name of the map that contains the data for this view or stream
 java.lang.String getSql()
           
 java.util.Map getValueAttributeMapping()
          Return the map which stores the mapping between SQL columns and value class field or accessor method.
 java.lang.Class getValueClass()
          Return the class type of the value stored in the ObjectMap.
 

Method Detail

getName

java.lang.String getName()
return the name of the stream or view

Returns:
the name of the stream or view

getObjectGridName

java.lang.String getObjectGridName()
return the ObjectGrid name of the map that contains the data for this view or stream

Returns:
the ObjectGrid name of the map

getMapName

java.lang.String getMapName()
return the ObjectGrid map name of the map that contains the data for this view or stream

Returns:
the map name

getValueClass

java.lang.Class getValueClass()
Return the class type of the value stored in the ObjectMap.

Returns:
the class type of the value stored in the ObjectMap

getSql

java.lang.String getSql()
Returns:
the sql for this stream

getValueAttributeMapping

java.util.Map getValueAttributeMapping()
Return the map which stores the mapping between SQL columns and value class field or accessor method. The key of the map is the SQL column name, and the value is the field name or the accessor method name. If the access type is AccessType.FIELD, then the value stored in this map is the field name. If the access type is AccessType.PROPERTY, then the value stored in this map is the access method.

Since the setValueAttributeMapping makes a copy of the passed-in map and changes all column names to lower case, so the returned map might not be equal to the map passed in the setValueAttributeMapping method.

Returns:
the map storing the mapping between SQL columns and value class accessor methods

getAccessType

AccessType getAccessType()
Get the access type. If the access type is AccessType.FIELD, then the SQL column values will be retrieved and set directly on the fileds using java reflection. If the access type is AccessType.PROPERTY, then the SQL column values will be retrieved and set using accessor methods.

Returns:
the access type
See Also:
AccessType

IBM WebSphere Extended Deployment (XD)TM, Release 6.1
ObjectGrid API Specification

© Copyright International Business Machines Corp 2005-2007. All rights reserved.