|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.waveset.object.RepositoryResult.Row
This class is used to represent each "row" of the result.
There will be two common forms of result:
Information results are typically returned by repository queries used to gather information about objects in order that one or more may be selected for futher processing. Since we don't know which objects will be selected, we don't bring them entirely into memory.
Object results are returned by repository queries where some collection of objects is known to be required. The information fields will also be set up.
It is the responsibility of the application to know which sort of result it is dealing with.
Field Summary | |
static java.lang.String |
EL_OBJECT
|
static java.lang.String |
EL_ROW
|
Constructor Summary | |
protected |
RepositoryResult.Row()
Create an empty row. |
protected |
RepositoryResult.Row(org.w3c.dom.Element e)
Create a row, and flesh it out by parsing its DOM representation. |
|
RepositoryResult.Row(int index,
LockInfo lockInfo)
|
|
RepositoryResult.Row(int index,
ObjectRef or)
|
|
RepositoryResult.Row(int index,
PersistentObject po)
|
|
RepositoryResult.Row(int index,
Type type,
java.lang.String name,
java.lang.String id,
WSAttributes attributes)
|
|
RepositoryResult.Row(LockInfo lockInfo)
Create a row containing lock information for an object. |
|
RepositoryResult.Row(ObjectRef or)
Create a row containing object information taken from an object reference. |
|
RepositoryResult.Row(PersistentObject po)
Create a row containing a reference to an object. |
|
RepositoryResult.Row(Type type,
java.lang.String name,
java.lang.String id,
PersistentObject po,
LockInfo lockInfo,
WSAttributes attributes)
Create a row containing object information. |
|
RepositoryResult.Row(Type type,
java.lang.String name,
java.lang.String displayName,
java.lang.String id,
WSAttributes attributes)
Create a row containing object information, including the displayName |
|
RepositoryResult.Row(Type type,
java.lang.String name,
java.lang.String id,
WSAttributes attributes)
Create a row containing object information. |
Method Summary | |
void |
clearObject()
Null out the PersistentObject stored with this row, if any. |
java.lang.String |
getAttribute(Attribute attr)
Convenience method to get one attribute value by registered Attribute. |
java.lang.String |
getAttribute(java.lang.String name)
Convenience method to get one summary attribute value by name. |
WSAttributes |
getAttributes()
Return the summary attributes exposed by this object. |
java.lang.Object[] |
getAttributeValues(Attribute attr)
Convenience method to get one multivalued summary attribute value by name. |
java.lang.Object[] |
getAttributeValues(java.lang.String name)
|
java.lang.String[] |
getAttributeValuesAsStrings(Attribute attr)
Convenience method to get one multivalued summary attribute's values by name. |
java.lang.String[] |
getAttributeValuesAsStrings(java.lang.String name)
|
java.lang.String |
getDisplayableName()
Get the object displayabl name. |
java.lang.String |
getDisplayName()
Get the object display name. |
java.lang.String |
getId()
Get the object ID. |
java.lang.String |
getIdOrName()
Get the object ID or name (preferring id). |
java.lang.String |
getLockedBy()
Get the name of the user holding a lock on this object. |
LockInfo |
getLockInfo()
Get the object lock information. |
java.lang.String |
getName()
Get the object name. |
java.lang.String |
getNameOrId()
Get the object name or id (preferring name). |
PersistentObject |
getObject()
Get the PersistentObject stored with this row, if any. |
WSAttributes |
getSummaryAttributes()
Deprecated. since GA 1.2. Use getAttributes() . |
Type |
getType()
Get the object type. |
WSAttribute |
getWSAttribute(java.lang.String name)
Convenience method to get one attribute by registered Attribute. |
protected void |
setAttributes(WSAttributes attributes)
Set the summary attributes for this object. |
protected void |
setDisplayName(java.lang.String s)
Set the object display name. |
protected void |
setId(java.lang.String s)
Set the object ID. |
protected void |
setLockInfo(LockInfo li)
Set the object lock information. |
protected void |
setName(java.lang.String s)
Set the object name. |
protected void |
setObject(PersistentObject po)
Set the PersistentObject stored with this row, if any. |
protected void |
setType(Type type)
Set the object type. |
java.lang.String |
toString()
|
void |
toXml(java.lang.StringBuffer b)
Serialize a row into an XML buffer. |
void |
toXml(java.lang.StringBuffer b,
int indent)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String EL_ROW
public static final java.lang.String EL_OBJECT
Constructor Detail |
protected RepositoryResult.Row()
protected RepositoryResult.Row(org.w3c.dom.Element e) throws WavesetException
public RepositoryResult.Row(PersistentObject po)
public RepositoryResult.Row(LockInfo lockInfo)
public RepositoryResult.Row(Type type, java.lang.String name, java.lang.String id, PersistentObject po, LockInfo lockInfo, WSAttributes attributes)
public RepositoryResult.Row(Type type, java.lang.String name, java.lang.String id, WSAttributes attributes)
public RepositoryResult.Row(Type type, java.lang.String name, java.lang.String displayName, java.lang.String id, WSAttributes attributes)
public RepositoryResult.Row(ObjectRef or)
public RepositoryResult.Row(int index, PersistentObject po)
public RepositoryResult.Row(int index, LockInfo lockInfo)
public RepositoryResult.Row(int index, Type type, java.lang.String name, java.lang.String id, WSAttributes attributes)
public RepositoryResult.Row(int index, ObjectRef or)
Method Detail |
public java.lang.String toString()
public Type getType()
protected void setType(Type type)
public java.lang.String getNameOrId()
public java.lang.String getIdOrName()
public java.lang.String getId()
protected void setId(java.lang.String s)
public java.lang.String getName()
protected void setName(java.lang.String s)
public java.lang.String getDisplayName()
public java.lang.String getDisplayableName()
protected void setDisplayName(java.lang.String s)
public LockInfo getLockInfo()
public java.lang.String getLockedBy()
getLockInfo
.
getLockInfo()
protected void setLockInfo(LockInfo li)
public WSAttributes getSummaryAttributes()
getAttributes()
.
These were originally called "summary" attributes, but we're now referring to them as "query" attributes over in PersistentObject. We could probably avoid the issue here, and just refer to them as "attributes".
public WSAttributes getAttributes()
These were originally called "summary" attributes, but we're now referring to them as "query" attributes over in PersistentObject. We could probably avoid the issue here, and just refer to them as "attributes".
protected void setAttributes(WSAttributes attributes)
GPC: may not need this if constructor will suffice.
public PersistentObject getObject()
protected void setObject(PersistentObject po)
public void clearObject()
public java.lang.String getAttribute(Attribute attr)
public WSAttribute getWSAttribute(java.lang.String name)
public java.lang.String getAttribute(java.lang.String name)
public java.lang.Object[] getAttributeValues(Attribute attr)
public java.lang.Object[] getAttributeValues(java.lang.String name)
public java.lang.String[] getAttributeValuesAsStrings(Attribute attr)
public java.lang.String[] getAttributeValuesAsStrings(java.lang.String name)
public void toXml(java.lang.StringBuffer b)
public void toXml(java.lang.StringBuffer b, int indent)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |