|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.wm.app.tn.doc.BizDocTypeReg
public class BizDocTypeReg
A registry for BizDocTypes. Included are methods for adding/deleting/updating the BizDocTypes and for determining the document type of a document.
Field Summary | |
---|---|
static boolean |
cacheXQLQueryResults
|
Constructor Summary | |
---|---|
BizDocTypeReg()
|
Method Summary | |
---|---|
void |
add(BizDocType bdt)
Adds a BizDocType to the registry. |
java.util.Hashtable |
getFamilyMap()
|
BizDocType |
getType(java.lang.String id)
Retrieves a BizDocType. |
BizDocType[] |
getTypes()
Retrieves all BizDocTypes. |
BizDocType[] |
getTypes(java.lang.String className)
Retrieves all BizDocTypes in a family. |
void |
mapMonitoredAttributes(com.wm.data.IData in,
BizDocEnvelope env)
|
java.util.Vector |
recognize(com.wm.data.IData in)
Tries to determine the type(s) of the inputted document based upon the existing lists of BizDocType(s). |
java.lang.String[] |
recognizeAll(com.wm.data.IData in)
Returns a list of all matching document types |
BizDocEnvelope |
recognizeAndCreate(com.wm.data.IData in)
Tries to determine the type of the inputted document based upon the existing lists of biz document types and returns a new BizDocEnvelope. |
BizDocType |
remove(BizDocType bdt)
Removes a BizDocType from the registry. |
java.lang.String |
toString()
|
BizDocType |
update(BizDocType bdt)
Updates a BizDocType. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static boolean cacheXQLQueryResults
Constructor Detail |
---|
public BizDocTypeReg()
Method Detail |
---|
public void add(BizDocType bdt)
bdt
- BizDocType to be added to the registry
BizDocTypeException
- may be thrown if the type exists Note: The id of the BizDocType
needs to be unique across all concrete types. The best way to get a unique id is to call
com.wm.app.tn.db.Counter.next().public BizDocType remove(BizDocType bdt)
name
- name of the BizDocType
public BizDocType update(BizDocType bdt) throws BizDocTypeRegException
bdt
- updated BizDocType replacing old one
BizDocTypeException
- may be thrown if the type does not exist
BizDocTypeRegException
public BizDocType getType(java.lang.String id)
id
- id of the BizDocType to be retrieved
public BizDocType[] getTypes(java.lang.String className)
className
- class name of the concreate BizDocType of interest
public BizDocType[] getTypes()
public java.util.Hashtable getFamilyMap()
public java.util.Vector recognize(com.wm.data.IData in) throws BizDocTypeException
in
- IData object containing keyword and document data
BizDocTypeException
public java.lang.String[] recognizeAll(com.wm.data.IData in) throws BizDocTypeException
in
- IData object containing keyword and document data
BizDocTypeException
public BizDocEnvelope recognizeAndCreate(com.wm.data.IData in) throws BizDocTypeException
in
- IData object containing keyword and document data
BizDocTypeException
public java.lang.String toString()
toString
in class java.lang.Object
public void mapMonitoredAttributes(com.wm.data.IData in, BizDocEnvelope env)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |