ch.elexis.omnivore.data
Class DocumentManagement

java.lang.Object
  ch.elexis.omnivore.data.DocumentManagement

All Implemented Interfaces:

IDocumentManager

public class DocumentManagement
extends java.lang.Object
implements IDocumentManager

Constructor Summary

DocumentManagement()

Method Summary

boolean	addCategory(java.lang.String categorie) Add a Categorie
java.lang.String	addDocument(IOpaqueDocument doc) Ad a document
java.lang.String[]	getCategories() List Categories for Documents
IOpaqueDocument	getDocument(java.lang.String id)
java.util.List<IOpaqueDocument>	listDocuments(java.lang.String patID, java.lang.String categoryMatch, java.lang.String titleMatch, java.lang.String keywordMatch, TimeSpan dateMatch, java.lang.String contentsMatch) Retrieve documents with matching criteria.
boolean	removeDocument(java.lang.String guid) remove and delete a document

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentManagement

public DocumentManagement()

Method Detail

addCategory

public boolean addCategory(java.lang.String categorie)

Description copied from interface: IDocumentManager

Add a Categorie

Specified by:

addCategory in interface IDocumentManager

addDocument

public java.lang.String addDocument(IOpaqueDocument doc)
                             throws ElexisException

Description copied from interface: IDocumentManager

Ad a document

Specified by:

addDocument in interface IDocumentManager

Parameters:

doc - The IDocument to add

Returns:

ID of the newly created internal representation

Throws:

ElexisException

getCategories

public java.lang.String[] getCategories()

Description copied from interface: IDocumentManager

List Categories for Documents

Specified by:

getCategories in interface IDocumentManager

getDocument

public IOpaqueDocument getDocument(java.lang.String id)

Specified by:

getDocument in interface IDocumentManager

listDocuments

public java.util.List<IOpaqueDocument> listDocuments(java.lang.String patID,
                                                     java.lang.String categoryMatch,
                                                     java.lang.String titleMatch,
                                                     java.lang.String keywordMatch,
                                                     TimeSpan dateMatch,
                                                     java.lang.String contentsMatch)
                                              throws ElexisException

Description copied from interface: IDocumentManager

Retrieve documents with matching criteria. If a parameter is null, it will be considered as "any". If a String parameter is enclosed in slashes, it will be considered as regex: "/m[ae]h/" will match mah and meh, while "m[ae]h" will only match the literal string m[ae]h.

Specified by:

listDocuments in interface IDocumentManager

Parameters:

patID - The ID of the patient the documents belong to

categoryMatch - the category or categories to match

titleMatch - title

keywordMatch - keyword to find. Will match if at least one of the documents keywords match the parameter

dateMatch - match only documents woth dates within the given timespan

contentsMatch - find a match in the contents of the document. Note: This is not supported by all documentmanagers and it might be very inefficient! If the parameter is not null and the implementation does not support contentMatch, it throws an ElexisException EE_NOT_SUPPORTED.

Returns:

lust of all IDocuments matching the goven criteria

Throws:

ElexisException

removeDocument

public boolean removeDocument(java.lang.String guid)

Description copied from interface: IDocumentManager

remove and delete a document

Specified by:

removeDocument in interface IDocumentManager

Parameters:

guid - the guid of the doucment to remove

Returns:

true on success