|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.wm.app.tn.db.Query
com.wm.app.tn.db.SimpleDocQuery
public class SimpleDocQuery
Simple queries on documents in the datastore. This class provides matching on envelope fields of the document (sender, receiver, doctype, etc.), and control over the results that are returned. Attributes will never be queried or returned by an SDQ. In general, setters will removed the associated criterion if handed a null value. For instance, setSender(null) will remove any sender criteria.
Field Summary | |
---|---|
static java.lang.String |
COMMENTS
|
static java.lang.String |
CONVID
|
static java.lang.String |
GROUPID
|
static java.lang.String |
INTERNALID
|
static java.lang.String |
MSGTYPE
|
static java.lang.String |
NATIVEID
|
static java.lang.String |
RECEIVERCORP
|
static java.lang.String |
RECEIVERPROFILEGROUP
|
static java.lang.String |
RECVRID
|
static java.lang.String |
SENDERCORP
|
static java.lang.String |
SENDERID
|
static java.lang.String |
SENDERPROFILEGROUP
|
static java.lang.String |
STATSYS
|
static java.lang.String |
STATUSR
|
static java.lang.String |
TASKSTATUS
|
static java.lang.String |
TIMESTAMP
|
static java.lang.String |
TYPENAME
|
Constructor Summary | |
---|---|
SimpleDocQuery()
Create a SimpleDocQuery. |
Method Summary | |
---|---|
void |
clearSortColumn()
Deprecated. As of TN 7.0, replaced by clearSortColumns() |
void |
clearSortColumns()
Clear sort order |
static com.wm.data.IData |
create()
For internal use only |
java.lang.Object |
getComments()
|
java.lang.Object |
getConversationId()
|
com.wm.data.IDataCursor |
getCursor()
For internal use only |
java.lang.Object |
getDocumentId()
|
java.lang.Object |
getGroupId()
|
com.wm.data.IDataHashCursor |
getHashCursor()
For internal use only |
com.wm.data.IDataIndexCursor |
getIndexCursor()
For internal use only |
java.lang.Object |
getInternalId()
|
java.lang.Object |
getMessageType()
|
java.lang.Object |
getReceiver()
|
java.lang.Object |
getReceiverProfileGroup()
|
java.lang.Object |
getRoutingStatus()
|
java.lang.Object |
getSender()
|
java.lang.Object |
getSenderProfileGroup()
|
com.wm.data.IDataSharedCursor |
getSharedCursor()
For internal use only |
java.lang.String |
getSortColumn()
Deprecated. As of TN 7.0, replaced by getSortColumns() |
java.lang.String[][] |
getSortColumns()
returns sort columns (may be null) |
java.lang.Object |
getTaskStatus()
|
java.sql.Timestamp[] |
getTimeInterval()
|
int |
getTimeIntervalType()
|
com.wm.data.IDataTreeCursor |
getTreeCursor()
For internal use only |
java.lang.Object |
getUserStatus()
|
java.util.Enumeration |
getVisibleColumns(boolean agg)
For internal use only |
boolean |
isCommentsVisible()
|
boolean |
isConversationIdVisible()
|
boolean |
isDocumentIdVisible()
|
boolean |
isGroupIdVisible()
|
boolean |
isMessageTypeVisible()
|
boolean |
isReceiverProfileGroupVisible()
|
boolean |
isReceiverVisible()
|
boolean |
isRoutingStatusVisible()
|
boolean |
isSenderProfileGroupVisible()
|
boolean |
isSenderVisible()
|
boolean |
isSortAscending()
Deprecated. As of TN 7.0, replaced by setSortColumns(String[][]) |
boolean |
isTaskStatusVisible()
|
boolean |
isTimestampVisible()
|
boolean |
isUserStatusVisible()
|
static void |
main(java.lang.String[] args)
For internal use only |
void |
preSql()
For internal use only |
void |
setComments(java.lang.String comments)
Search for documents with a specific comment |
void |
setComments(java.lang.String[][] opValue,
boolean isORquery)
Search for documents using multiple criterias on comment |
void |
setCommentsVisible(boolean b)
|
void |
setConversationId(java.lang.String id)
Search for documents with a particular conversation ID |
void |
setConversationId(java.lang.String[][] opValue,
boolean isORquery)
Search for documents using multiple criterias on conversation id. |
void |
setConversationIdVisible(boolean b)
|
void |
setDaysAgo(int ago)
Query by document timestamp, based on "number of days ago". |
void |
setDocumentId(java.lang.String id)
Search for documents with a particular document ID |
void |
setDocumentId(java.lang.String[][] opValue,
boolean isORquery)
Search for documents using multiple criterias on document id. |
void |
setDocumentIdVisible(boolean b)
|
void |
setGroupId(java.lang.String id)
Search for documents with a particular group ID |
void |
setGroupId(java.lang.String[][] opValue,
boolean isORquery)
Search for documents using multiple criterias on group id. |
void |
setGroupIdVisible(boolean b)
|
void |
setInternalId(java.lang.String id)
Search for documents using internal id. |
void |
setInternalId(java.lang.String[][] opValue,
boolean isORquery)
Search for documents using multiple criterias on internal id. |
void |
setMessageType(java.lang.String typeId)
Search for documents of a particular type |
void |
setMessageType(java.lang.String[] typeId)
Search for documents with a group of types |
void |
setMessageType(java.lang.String[][] opValue,
boolean isORquery)
Search for documents using multiple criterias on doc types |
void |
setMessageTypeVisible(boolean b)
|
void |
setReceiver(com.wm.data.IData criteria)
Search for documents from a list of receiver ids or a profile sub query |
void |
setReceiver(ProfileQuery query)
Search for documents from a group of receivers using a IN sub query e.g. |
void |
setReceiver(java.lang.String id)
Search for documents for a single receiver |
void |
setReceiver(java.lang.String[] id)
Search for documents for a group of receivers |
void |
setReceiverProfileGroup(java.lang.String[][] opValue,
boolean isORquery)
Search for documents using multiple criterias on Recevier Profile group. |
void |
setReceiverProfileGroupVisible(boolean b)
|
void |
setReceiverVisible(boolean b)
|
void |
setRecevierProfileGroup(java.lang.String receiverProfileGroup)
Search for documents with a particular Recevier Profile group |
void |
setRoutingStatus(java.lang.String status)
Search for documents in a particular routing status |
void |
setRoutingStatus(java.lang.String[] status)
Search for documents with a group of routing statuses |
void |
setRoutingStatus(java.lang.String[][] opValue,
boolean isORquery)
Search for documents using multiple criterias on routing status. |
void |
setRoutingStatusVisible(boolean b)
|
void |
setSender(com.wm.data.IData criteria)
Search for documents from a list of sender ids or a profile sub query |
void |
setSender(ProfileQuery query)
Search for documents from a group of senders using a profile sub query e.g. |
void |
setSender(java.lang.String id)
Search for documents from a single sender. |
void |
setSender(java.lang.String[] id)
Search for documents from a group of senders |
void |
setSenderProfileGroup(java.lang.String senderProfileGroup)
Search for documents with a particular Sender Profile group |
void |
setSenderProfileGroup(java.lang.String[][] opValue,
boolean isORquery)
Search for documents using multiple criterias on Sender Profile group. |
void |
setSenderProfileGroupVisible(boolean b)
|
void |
setSenderVisible(boolean b)
|
void |
setSortColumn(java.lang.String col,
boolean asc)
Deprecated. As of TN 7.0, replaced by setSortColumns(String[][]) |
void |
setSortColumns(java.lang.String[][] columnOrder)
Set the sort columns and order for this query. |
void |
setTaskStatus(java.lang.String status)
Search for documents based on task satus |
void |
setTaskStatus(java.lang.String[][] opValue,
boolean isORquery)
Search for documents using multiple criterias on task status |
void |
setTaskStatusVisible(boolean b)
|
void |
setTimeInterval(int which)
Set the time interval based on simple codes. |
void |
setTimeInterval(java.sql.Timestamp since,
java.sql.Timestamp until)
Set the time interval based on absolute times. |
void |
setTimestampVisible(boolean b)
|
void |
setUserStatus(java.lang.String status)
Search for documents in a particular user status |
void |
setUserStatus(java.lang.String[][] opValue,
boolean isORquery)
Search for documents using multiple criterias on user status. |
void |
setUserStatusVisible(boolean b)
|
java.lang.String |
toSql()
|
java.lang.String |
toSql(boolean agg)
For internal use only |
java.lang.String |
toString()
For internal use only |
Methods inherited from class com.wm.app.tn.db.Query |
---|
beginningOfDay, escapeString, evaluate, evaluateListConditions, generateClause, generateClause, generateColumnList, generateComp, generateComp, generateComp, generateListComp, generateNumericClause, generateStringLit, generateStringLit, generateTimeInterval, generateTimestampLiteral, getIntervalType, getUnique, isDateTime, isDistinct, isIndentSql, isOR, searchMWS, setDistinct, setIndentSql, setOR, setViewPermission |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String TIMESTAMP
public static final java.lang.String INTERNALID
public static final java.lang.String SENDERID
public static final java.lang.String RECVRID
public static final java.lang.String MSGTYPE
public static final java.lang.String STATSYS
public static final java.lang.String STATUSR
public static final java.lang.String NATIVEID
public static final java.lang.String GROUPID
public static final java.lang.String SENDERPROFILEGROUP
public static final java.lang.String RECEIVERPROFILEGROUP
public static final java.lang.String CONVID
public static final java.lang.String COMMENTS
public static final java.lang.String TASKSTATUS
public static final java.lang.String SENDERCORP
public static final java.lang.String RECEIVERCORP
public static final java.lang.String TYPENAME
Constructor Detail |
---|
public SimpleDocQuery()
SELECT * FROM BizDoc
Method Detail |
---|
public com.wm.data.IDataCursor getCursor()
getCursor
in interface com.wm.data.IData
public com.wm.data.IDataSharedCursor getSharedCursor()
getSharedCursor
in interface com.wm.data.IData
public com.wm.data.IDataIndexCursor getIndexCursor()
getIndexCursor
in interface com.wm.data.IData
public com.wm.data.IDataTreeCursor getTreeCursor()
getTreeCursor
in interface com.wm.data.IData
public com.wm.data.IDataHashCursor getHashCursor()
getHashCursor
in interface com.wm.data.IData
public java.lang.String toString()
toString
in class java.lang.Object
public void setInternalId(java.lang.String id)
id
- the internal id of the document to look forpublic void setInternalId(java.lang.String[][] opValue, boolean isORquery)
opValue
- is the operator and value pair in String[][]
(e.g. {{Query.OP_COMP_CONTAINS, "123"}, {Query.OP_COMP_NEQ, "123456789012345678901234"}})isORquery
- should OR operator be used between these criterias?public void setSender(java.lang.String id)
id
- the id of the sender to look forpublic void setSender(java.lang.String[] id)
id
- the ids of the senderspublic void setSender(ProfileQuery query)
query
- the profile query that serves as the
subquery in ()public void setSender(com.wm.data.IData criteria)
criteria
- IData
key="ids" value=String[] ids
key="profileQuery" value=ProfileQuery querypublic void setReceiver(java.lang.String id)
id
- the id of the receiver to look forpublic void setReceiver(java.lang.String[] id)
id
- the ids of the receiverspublic void setReceiver(ProfileQuery query)
query
- the profile query that serves as the
subquery in ()public void setReceiver(com.wm.data.IData criteria)
criteria
- IData
key="ids" value=String[] ids
key="profileQuery" value=ProfileQuery querypublic void setMessageType(java.lang.String typeId)
type
- the type name to look forcontains
- should this be a CONTAINS query (as opposed to a simple EQ)?public void setMessageType(java.lang.String[] typeId)
type
- the type names to look forpublic void setMessageType(java.lang.String[][] opValue, boolean isORquery)
opValue
- is the operator and value pair in String[][]
(e.g. {{Query.OP_COMP_CONTAINS, "1234"}, {Query.OP_COMP_NEQ, "5678"}})isORquery
- should OR operator be used between these criterias?public void setRoutingStatus(java.lang.String status)
status
- the status to look forcontains
- should this be a CONTAINS query (as opposed to a simple EQ)?public void setRoutingStatus(java.lang.String[] status)
status
- the statuses to look forpublic void setRoutingStatus(java.lang.String[][] opValue, boolean isORquery)
opValue
- is the operator and value pair in String[][]
(e.g. {{Query.OP_COMP_CONTAINS, "Route"}, {Query.OP_COMP_NEQ, "Routing Complete"}})isORquery
- should OR operator be used between these criterias?public void setUserStatus(java.lang.String status)
status
- the status to look forpublic void setUserStatus(java.lang.String[][] opValue, boolean isORquery)
opValue
- is the operator and value pair in String[][]
(e.g. {{Query.OP_COMP_CONTAINS, "Route"}, {Query.OP_COMP_NEQ, "Routing Complete"}})isORquery
- should OR operator be used between these criterias?public void setDocumentId(java.lang.String id)
id
- the ID to look forpublic void setDocumentId(java.lang.String[][] opValue, boolean isORquery)
opValue
- is the operator and value pair in String[][]
(e.g. {{Query.OP_COMP_CONTAINS, "123"}, {Query.OP_COMP_NEQ, "123456789012345678901234"}})isORquery
- should OR operator be used between these criterias?public void setGroupId(java.lang.String id)
id
- the ID to look forpublic void setGroupId(java.lang.String[][] opValue, boolean isORquery)
opValue
- is the operator and value pair in String[][]
(e.g. {{Query.OP_COMP_CONTAINS, "123"}, {Query.OP_COMP_NEQ, "123456789012345678901234"}})isORquery
- should OR operator be used between these criterias?public void setConversationId(java.lang.String id)
id
- the ID to look forpublic void setConversationId(java.lang.String[][] opValue, boolean isORquery)
opValue
- is the operator and value pair in String[][]
(e.g. {{Query.OP_COMP_CONTAINS, "123"}, {Query.OP_COMP_NEQ, "123456789012345678901234"}})isORquery
- should OR operator be used between these criterias?public void setComments(java.lang.String comments)
comments
- the Comments to look forpublic void setComments(java.lang.String[][] opValue, boolean isORquery)
opValue
- is the operator and value pair in String[][]
(e.g. {{Query.OP_COMP_CONTAINS, "123"}, {Query.OP_COMP_NEQ, "123456789012345678901234"}})isORquery
- should OR operator be used between these criterias?public void setTaskStatus(java.lang.String status)
status
- the task status to look forpublic void setTaskStatus(java.lang.String[][] opValue, boolean isORquery)
opValue
- is the operator and value pair in String[][]
(e.g. {{Query.OP_COMP_CONTAINS, "123"}, {Query.OP_COMP_NEQ, "123456789012345678901234"}})isORquery
- should OR operator be used between these criterias?public void setDaysAgo(int ago)
ago
- how many 24-hour days to go back (0 is till midnight last
night, 1 is 24 hours ago, 2 is 48 hours ago, and so on)public void setTimeInterval(int which)
which
- the interval to usepublic void setTimeInterval(java.sql.Timestamp since, java.sql.Timestamp until)
setTimeInterval
in class Query
since
- the start of the interval (null means open-ended)until
- the end of the interval (null means open-ended)public void setSenderProfileGroup(java.lang.String senderProfileGroup)
senderProfileGroup
- the ID to look forpublic void setSenderProfileGroup(java.lang.String[][] opValue, boolean isORquery)
opValue
- is the operator and value pair in String[][]
(e.g. {{Query.OP_COMP_CONTAINS, "123"}, {Query.OP_COMP_NEQ, "123456789012345678901234"}})isORquery
- should OR operator be used between these criterias?public void setRecevierProfileGroup(java.lang.String receiverProfileGroup)
senderProfileGroup
- the ID to look forpublic void setReceiverProfileGroup(java.lang.String[][] opValue, boolean isORquery)
opValue
- is the operator and value pair in String[][]
(e.g. {{Query.OP_COMP_CONTAINS, "123"}, {Query.OP_COMP_NEQ, "123456789012345678901234"}})isORquery
- should OR operator be used between these criterias?public java.lang.Object getInternalId()
public java.lang.Object getSender()
public java.lang.Object getSenderProfileGroup()
public java.lang.Object getReceiver()
public java.lang.Object getReceiverProfileGroup()
public java.lang.Object getMessageType()
public java.lang.Object getRoutingStatus()
public java.lang.Object getUserStatus()
public java.lang.Object getDocumentId()
public java.lang.Object getGroupId()
public java.lang.Object getConversationId()
public java.lang.Object getComments()
public java.lang.Object getTaskStatus()
public java.sql.Timestamp[] getTimeInterval()
public int getTimeIntervalType()
public void setTimestampVisible(boolean b)
public void setSenderVisible(boolean b)
public void setReceiverVisible(boolean b)
public void setMessageTypeVisible(boolean b)
public void setRoutingStatusVisible(boolean b)
public void setUserStatusVisible(boolean b)
public void setDocumentIdVisible(boolean b)
public void setGroupIdVisible(boolean b)
public void setConversationIdVisible(boolean b)
public void setCommentsVisible(boolean b)
public void setTaskStatusVisible(boolean b)
public void setSenderProfileGroupVisible(boolean b)
public void setReceiverProfileGroupVisible(boolean b)
public boolean isTimestampVisible()
public boolean isSenderVisible()
public boolean isReceiverVisible()
public boolean isMessageTypeVisible()
public boolean isRoutingStatusVisible()
public boolean isUserStatusVisible()
public boolean isDocumentIdVisible()
public boolean isGroupIdVisible()
public boolean isConversationIdVisible()
public boolean isCommentsVisible()
public boolean isTaskStatusVisible()
public boolean isSenderProfileGroupVisible()
public boolean isReceiverProfileGroupVisible()
public void setSortColumns(java.lang.String[][] columnOrder)
setSortColumns
in class Query
columnOrder
- takes column names and sort orders
(e.g. {{TIMESTAMP, "ASC"}, {SENDERID, "DESC"}} )public java.lang.String[][] getSortColumns()
public void clearSortColumns()
public void setSortColumn(java.lang.String col, boolean asc)
setSortColumns(String[][])
public java.lang.String getSortColumn()
getSortColumns()
public boolean isSortAscending()
setSortColumns(String[][])
public void clearSortColumn()
clearSortColumns()
public void preSql()
preSql
in class Query
public java.lang.String toSql()
toSql
in class Query
public java.lang.String toSql(boolean agg)
public java.util.Enumeration getVisibleColumns(boolean agg)
public static com.wm.data.IData create()
public static void main(java.lang.String[] args) throws java.lang.Exception
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |