|
Business Components | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.jbo.common.BaseObject | +--oracle.jbo.server.RowImpl | +--oracle.jbo.server.ViewRowImpl
A View Object Row. This class provides access to a View Object Row. The View Object Row can contain one or more Entity Object Rows in addition to derived attributes such as calculated columns.
The Business Components for Java framework instantiates an object of this class for each record that is returned by the row's View Object query. This class can be referred to by middle-tier customer application logic in order to access View Object Row data.
Customers can extend this class with custom View Object Row implementations. For example, the Business Components for Java View Object wizard can be used to generate sub-classes of this class that define type-safe accessors/mutators for the attributes of a row. Custom sub-classes should be declard to the Business Components for Java framework through the View Object wizard.
Customer applications should not access this class on the client-tier of an
application. Instead, the Row
interface should be
used for client tier access.
RowImpl
,
Row
Field Summary | |
static java.lang.String |
XML_POSTSTATE_REMOVE
|
static java.lang.String |
XML_POSTSTATE_TAG
|
Fields inherited from class oracle.jbo.common.BaseObject |
TRACE_EVERY_ALLOC,
TRACE_NONE,
TRACE_OCCASIONAL,
TRACE_UNINITIALIZED |
Fields inherited from interface oracle.jbo.XMLInterface |
XML_OPT_ALL_ROWS,
XML_OPT_ASSOC_CONSISTENT,
XML_OPT_CHANGES_ONLY,
XML_OPT_LIMIT_RANGE |
Constructor Summary | |
ViewRowImpl()
Public constructor for this class. |
Method Summary | |
protected void |
appendXMLElementNodes(org.w3c.dom.Document xmlDoc,
org.w3c.dom.Node node,
int depthCount,
long options,
AttributeDefImpl[] attrs)
Writes XML-element nodes for each attribute in this row and appends it to the given row-node. |
protected void |
create(AttributeList nvp)
Initialization method to be over-ridden in generated code for custom defaulting. |
protected EntityImpl[] |
createEntities()
Creates blank instances of the Entity Objects that this row is composed of. |
boolean |
equals(java.lang.Object other)
Tests if the specified value is equal to this ViewRowImpl object. |
protected RowSet |
findAssociatedObjects(java.lang.String name)
Finds Objects in a ViewRowSetImpl that follow the given association. |
ApplicationModule |
getApplicationModule()
Gets the Application Module to which the containing View Object belongs. |
java.lang.Object |
getAttribute(int ix)
Selects the attribute at the given index. |
java.lang.Object |
getAttribute(java.lang.String name)
Gets the value of an attribute by name. |
int |
getAttributeCount()
Gets the attribute count in this ViewRow. |
int |
getAttributeIndexOf(java.lang.String alias)
Gets the index of the attribute, given it's name. |
protected java.lang.Object |
getAttributeInternal(int index)
Gets the value of the attribute by index. |
protected EntityImpl |
getEntity(int index)
Gets the Entity at the given index. |
Entity |
getEntityForAttribute(java.lang.String attrName)
Gets an entity object that contains the given attribute name. |
java.lang.Object |
getHandle()
Creates a row identifier that is unique in the query collection. |
Key |
getKey()
Returns the identifier object for this row. |
QueryCollection |
getQueryCollection(java.lang.Object accessKey)
Gets the QueryCollection this row exists in. |
ViewObject |
getViewObject()
Gets the View Object to which this row belongs. |
protected java.lang.String |
getXMLElementTag()
Returns the XML-element tag for this row. |
int |
hashCode()
Computes an integer hash code for this ViewRowImpl object |
boolean |
isAttributeUpdateable(int index)
Tests if an attribute is updateable. |
void |
lock()
Locks the referenced Entity Rows. |
protected void |
populate(java.sql.ResultSet resultSet)
Internal: Applications should not use this method. |
protected void |
populateAttribute(int index,
java.lang.Object value)
|
protected void |
populateAttributeAsChanged(int index,
java.lang.Object value)
|
protected void |
readAttributeFromXMLElement(org.w3c.dom.Node rowElt,
AttributeDefImpl ad)
|
void |
readXML(org.w3c.dom.Element rowElt,
int depthCount)
Reads the content of the row and updates the attributes, from given XML document. |
void |
remove()
Deletes the row. |
protected org.w3c.dom.Element |
renderAttributeInXMLElement(org.w3c.dom.Document xmlDoc,
AttributeDefImpl ad,
boolean explicitNull)
|
void |
revert()
Reverts this row back to its initial state. |
void |
setAttribute(int index,
java.lang.Object val)
Sets an attribute. |
void |
setAttribute(java.lang.String name,
java.lang.Object val)
Sets the value of an attribute by name. |
protected void |
setAttributeInternal(int index,
java.lang.Object val)
This is an "inner" accessor for an attribute and does not call out to the getXXX() method. |
protected void |
setEntities(EntityImpl[] rows)
Sets the entities that this view row is composed of. |
void |
validate()
Calls validate on each this view row's Entity Objects. |
Methods inherited from class oracle.jbo.server.RowImpl |
createXMLDefinition,
getAttributeInternal,
printXMLDefinition,
readXML,
setAttributeInternal,
writeXML,
writeXML |
Methods inherited from class oracle.jbo.common.BaseObject |
dumpState,
setTraceLevel,
setTraceWriter |
Methods inherited from class java.lang.Object |
clone,
finalize,
getClass,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
public static final java.lang.String XML_POSTSTATE_TAG
public static final java.lang.String XML_POSTSTATE_REMOVE
Constructor Detail |
public ViewRowImpl()
Method Detail |
protected void create(AttributeList nvp)
This method invokes create(AttributeList)
on each of the "new" entities
that make up this View Row.
The attribute list nvp is simply passed to the new entity rows that make up this View Row.
Note: the names in the attribute list are not transformed into entity-relative names hoping that the caller has done so already. If not, the entity's create() method might fail.
nvp
- the list of attributtes.public QueryCollection getQueryCollection(java.lang.Object accessKey)
public java.lang.Object getHandle()
Each row in a collection can be identified by either its Java object reference or by its row handle. The row handle, together with the collection name, forms an identifier that can be stored externally, in order to identify the row in future operations.
Applications should not rely on indentifier having a specific format: it is subject to change.
A row handle can be converted to a string using toString()
methods, and compared using equals
public Key getKey()
public void validate()
protected java.lang.Object getAttributeInternal(int index)
Note that this is an "inner" accessor for an attribute and does
not callout to the generated getXXX() method
on a subclass of a
ViewRowImpl. getAttribute()
methods are the "outer"
methods that callout to a subclass's getXXX() method where
XXX is the name of the attribute.
index
- the index of the attribute.public java.lang.Object getAttribute(int ix)
index
- an integer in the range 0
to getAttributeCount() - 1
.index
.public final java.lang.Object getAttribute(java.lang.String name)
name
- the name of the attribute.public final void setAttribute(java.lang.String name, java.lang.Object val)
name
- the name of the attribute.val
- the value of the attribute.public void setAttribute(int index, java.lang.Object val)
This method performs a type-check on the value, so that it matches the Java type of the attribute.
index
- the index of the attribute.val
- the new value.protected void setAttributeInternal(int index, java.lang.Object val)
This method also does not perform any type-check for the value's java type and assumes that the value-type is same as the java-type for this attribute.
index
- The index of the attribute.val
- The value.public final ViewObject getViewObject()
public final ApplicationModule getApplicationModule()
public int getAttributeIndexOf(java.lang.String alias)
alias
- the alias of the attribute.protected EntityImpl[] createEntities()
public void lock()
public void revert()
public void remove()
remove
on the updateable Entity Rows that are referenced by this View Object Row.
After the referenced, updateable entity rows have been removed this method
will remove the View Object Row from the View Object's RowSet.protected final EntityImpl getEntity(int index)
index
- the index of the Entity.public final Entity getEntityForAttribute(java.lang.String attrName)
attrName
- name of an attributeprotected final void setEntities(EntityImpl[] rows)
This method is called by framework, after entites are created for this row. This must be protected because subclasses can create their own entity instances and have the viewrow manage them.
For example, assume there is a ViewRow on the Doc Entity where Doc has subclasses PO and Req, the ViewRow subclass can create PO/Req instances of entities based on some logic and have ViewRow manage them as an entity of type Doc.
public final int getAttributeCount()
public boolean isAttributeUpdateable(int index)
index
- the index of the attribute.true
if the row is marked UPDATEABLE
,
or if the row is marked UPDATEABLE_WHILE_NEW
and the current row is new.protected void populate(java.sql.ResultSet resultSet)
Populate this row from the ResultSet.
This is a Framework-internal method. This method is used to fill in entity-attributes from a JDBC ResultSet that is returned by executeQuery().
Note that the method works on the current row of the result set and any currecy change on the ResultSet could throw it off. This method is protected to let sub-ViewRows fill in custom-entities created based on data.
For example, if fax is a subtype of doc and based on a column value, either doc is created or a fax is created for a given entity type, this method may be used to create entities based on the data values. Note that the developer needs to know exact position of values in the JDBC ResultSet.
resultSet
- the JDBC ResultSet containing the row data.protected void populateAttribute(int index, java.lang.Object value)
protected void populateAttributeAsChanged(int index, java.lang.Object value)
protected RowSet findAssociatedObjects(java.lang.String name)
name
- that defines the associationpublic int hashCode()
public boolean equals(java.lang.Object other)
other
- the object to which the ViewRowImpl should be compared.protected java.lang.String getXMLElementTag()
protected void appendXMLElementNodes(org.w3c.dom.Document xmlDoc, org.w3c.dom.Node node, int depthCount, long options, AttributeDefImpl[] attrs)
Override this method to perform custom XML-rendering on a Row.
xmlDoc
- name of the XML document where the node resides.node
- the name of the Row object node where new nodes will be appended.depthCount
- number of child levels deep to appendrow nodes.options
- a set of bit flags that will control the writeXML behavior.attrs
- an array of AttriubuteDefImpls.protected org.w3c.dom.Element renderAttributeInXMLElement(org.w3c.dom.Document xmlDoc, AttributeDefImpl ad, boolean explicitNull)
protected void readAttributeFromXMLElement(org.w3c.dom.Node rowElt, AttributeDefImpl ad)
public final void readXML(org.w3c.dom.Element rowElt, int depthCount)
remove()
on this row.rowElt
- name of the XML element.depthCount
- the number of child levels deep to which data should be read.
|
Business Components | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |