com.openkm.dao

Class NodeDocumentDAO

java.lang.Object

com.openkm.dao.NodeDocumentDAO

public class NodeDocumentDAO
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelCheckout(String user, String uuid, boolean force) Cancel checkout
void	checkout(String user, String uuid) Checkout
NodeDocumentVersion	create(NodeDocument nDoc, InputStream is, long size) Create document and first version
void	delete(String name, String uuid, String trashUuid) Delete document
List<NodeDocument>	findAll() Find all documents
List<NodeDocument>	findByCategory(String catUuid) Search nodes by category
List<NodeDocument>	findByKeyword(String keyword) Search nodes by keyword
List<NodeDocument>	findByParent(String parentUuid) Find by parent
NodeDocument	findByPk(String uuid) Find by pk
NodeDocument	findByPk(String uuid, boolean initPropGroups) Find by pk and optionally initialize node property groups
List<NodeDocument>	findByPropertyValue(String group, String property, String value) Search nodes by property value
List<NodeDocument>	findFromParent(String parentUuid) Search nodes from a given parent recursively
String	getExtractedText(org.hibernate.Session session, String uuid) Get extracted text.
String	getExtractedText(String uuid) Get extracted text.
static NodeDocumentDAO	getInstance()
NodeLock	getLock(String uuid) Test for locked status
List<TextExtractorWork>	getPendingExtractions(int maxResults) Get pending extraction queue
long	getPendingExtractionSize() Get pending extraction size
long	getSize(String context) Get document node size.
long	getSubtreeSize(String path) Get document node size.
boolean	hasChildren(String parentUuid) Check if folder has children
boolean	hasPendingExtractions() Check for extraction queue
void	initialize(NodeDocument nDocument, boolean initPropGroups) Force initialization of a proxy
boolean	isCheckedOut(String uuid) Test for checked out status
boolean	isLocked(String uuid) Test for locked status
boolean	isTextExtracted(String uuid) Check if text has been already extracted.
boolean	isValid(String uuid) Check for a valid document node.
void	liveEditCancelCheckout(String user, String uuid, boolean force) Cancel checkout and delete temporal file.
void	lock(org.hibernate.Session session, String user, NodeDocument nDoc) Lock node
NodeLock	lock(String user, String uuid) Lock node
void	move(String uuid, String dstUuid) Move document
void	purge(String uuid) Purge in depth
void	purgeHelper(org.hibernate.Session session, String parentUuid) Purge in depth helper
NodeDocument	rename(String uuid, String newName) Rename document
int	resetAllPendingExtractionFlags() Clear pending extraction queue
int	resetPendingExtractionFlag(String docUuid) Clear pending extraction queue Note: the HQL query fails due to https://hibernate.atlassian.net/browse/HHH-1657
String	textExtractorHelper(TextExtractorWork work) Helps on extracting text from documents
void	unlock(org.hibernate.Session session, String user, NodeDocument nDoc, boolean force) Unlock node
void	unlock(String user, String uuid, boolean force) Unlock node

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static NodeDocumentDAO getInstance()

create

public NodeDocumentVersion create(NodeDocument nDoc,
                         InputStream is,
                         long size)
                           throws PathNotFoundException,
                                  AccessDeniedException,
                                  ItemExistsException,
                                  DatabaseException,
                                  IOException

Create document and first version

Throws:

PathNotFoundException

AccessDeniedException

ItemExistsException

DatabaseException

IOException

findAll

public List<NodeDocument> findAll()
                           throws DatabaseException

Find all documents

Throws:

DatabaseException

findByParent

public List<NodeDocument> findByParent(String parentUuid)
                                throws PathNotFoundException,
                                       DatabaseException

Find by parent

Throws:

PathNotFoundException

DatabaseException

findByPk

public NodeDocument findByPk(String uuid)
                      throws PathNotFoundException,
                             DatabaseException

Find by pk

Throws:

PathNotFoundException

DatabaseException

findByPk

public NodeDocument findByPk(String uuid,
                    boolean initPropGroups)
                      throws PathNotFoundException,
                             DatabaseException

Find by pk and optionally initialize node property groups

Throws:

PathNotFoundException

DatabaseException

findByCategory

public List<NodeDocument> findByCategory(String catUuid)
                                  throws PathNotFoundException,
                                         DatabaseException

Search nodes by category

Throws:

PathNotFoundException

DatabaseException

findByKeyword

public List<NodeDocument> findByKeyword(String keyword)
                                 throws DatabaseException

Search nodes by keyword

Throws:

DatabaseException

findByPropertyValue

public List<NodeDocument> findByPropertyValue(String group,
                                     String property,
                                     String value)
                                       throws DatabaseException

Search nodes by property value

Throws:

DatabaseException

findFromParent

public List<NodeDocument> findFromParent(String parentUuid)
                                  throws DatabaseException

Search nodes from a given parent recursively

Throws:

DatabaseException

hasChildren

public boolean hasChildren(String parentUuid)
                    throws PathNotFoundException,
                           DatabaseException

Check if folder has children

Throws:

PathNotFoundException

DatabaseException

rename

public NodeDocument rename(String uuid,
                  String newName)
                    throws PathNotFoundException,
                           AccessDeniedException,
                           ItemExistsException,
                           LockException,
                           DatabaseException

Rename document

Throws:

PathNotFoundException

AccessDeniedException

ItemExistsException

LockException

DatabaseException

move

public void move(String uuid,
        String dstUuid)
          throws PathNotFoundException,
                 AccessDeniedException,
                 ItemExistsException,
                 LockException,
                 DatabaseException

Move document

Throws:

PathNotFoundException

AccessDeniedException

ItemExistsException

LockException

DatabaseException

delete

public void delete(String name,
          String uuid,
          String trashUuid)
            throws PathNotFoundException,
                   AccessDeniedException,
                   LockException,
                   DatabaseException

Delete document

Throws:

PathNotFoundException

AccessDeniedException

LockException

DatabaseException

checkout

public void checkout(String user,
            String uuid)
              throws PathNotFoundException,
                     AccessDeniedException,
                     LockException,
                     DatabaseException

Checkout

Throws:

PathNotFoundException

AccessDeniedException

LockException

DatabaseException

cancelCheckout

public void cancelCheckout(String user,
                  String uuid,
                  boolean force)
                    throws PathNotFoundException,
                           AccessDeniedException,
                           LockException,
                           DatabaseException

Cancel checkout

Throws:

PathNotFoundException

AccessDeniedException

LockException

DatabaseException

isCheckedOut

public boolean isCheckedOut(String uuid)
                     throws PathNotFoundException,
                            DatabaseException

Test for checked out status

Throws:

PathNotFoundException

DatabaseException

purge

public void purge(String uuid)
           throws PathNotFoundException,
                  AccessDeniedException,
                  LockException,
                  DatabaseException,
                  IOException

Purge in depth

Throws:

PathNotFoundException

AccessDeniedException

LockException

DatabaseException

IOException

purgeHelper

public void purgeHelper(org.hibernate.Session session,
               String parentUuid)
                 throws PathNotFoundException,
                        AccessDeniedException,
                        LockException,
                        IOException,
                        DatabaseException,
                        org.hibernate.HibernateException

Purge in depth helper

Throws:

PathNotFoundException

AccessDeniedException

LockException

IOException

DatabaseException

org.hibernate.HibernateException

See Also:

com.openkm.dao.NodeFolderDAO.purgeHelper(Session, NodeFolder, boolean), com.openkm.dao.NodeMailDAO.purgeHelper(Session, NodeMail)

lock

public NodeLock lock(String user,
            String uuid)
              throws PathNotFoundException,
                     AccessDeniedException,
                     LockException,
                     DatabaseException

Lock node

Throws:

PathNotFoundException

AccessDeniedException

LockException

DatabaseException

lock

public void lock(org.hibernate.Session session,
        String user,
        NodeDocument nDoc)
          throws org.hibernate.HibernateException,
                 LockException

Lock node

Throws:

org.hibernate.HibernateException

LockException

unlock

public void unlock(String user,
          String uuid,
          boolean force)
            throws PathNotFoundException,
                   AccessDeniedException,
                   DatabaseException,
                   LockException

Unlock node

Throws:

PathNotFoundException

AccessDeniedException

DatabaseException

LockException

unlock

public void unlock(org.hibernate.Session session,
          String user,
          NodeDocument nDoc,
          boolean force)
            throws org.hibernate.HibernateException,
                   LockException

Unlock node

Throws:

org.hibernate.HibernateException

LockException

isLocked

public boolean isLocked(String uuid)
                 throws PathNotFoundException,
                        DatabaseException

Test for locked status

Throws:

PathNotFoundException

DatabaseException

getLock

public NodeLock getLock(String uuid)
                 throws PathNotFoundException,
                        LockException,
                        DatabaseException

Test for locked status

Throws:

PathNotFoundException

LockException

DatabaseException

getSize

public long getSize(String context)
             throws PathNotFoundException,
                    DatabaseException

Get document node size.

Throws:

PathNotFoundException

DatabaseException

See Also:

com.openkm.module.nr.NrStatsModule

getSubtreeSize

public long getSubtreeSize(String path)
                    throws PathNotFoundException,
                           DatabaseException

Get document node size.

Throws:

PathNotFoundException

DatabaseException

See Also:

com.openkm.module.nr.NrStatsModule

resetAllPendingExtractionFlags

public int resetAllPendingExtractionFlags()
                                   throws DatabaseException

Clear pending extraction queue

Throws:

DatabaseException

resetPendingExtractionFlag

public int resetPendingExtractionFlag(String docUuid)
                               throws DatabaseException

Clear pending extraction queue Note: the HQL query fails due to https://hibernate.atlassian.net/browse/HHH-1657

Throws:

DatabaseException

hasPendingExtractions

public boolean hasPendingExtractions()
                              throws DatabaseException

Check for extraction queue

Throws:

DatabaseException

getPendingExtractions

public List<TextExtractorWork> getPendingExtractions(int maxResults)
                                              throws DatabaseException

Get pending extraction queue

Throws:

DatabaseException

getPendingExtractionSize

public long getPendingExtractionSize()
                              throws DatabaseException

Get pending extraction size

Throws:

DatabaseException

textExtractorHelper

public String textExtractorHelper(TextExtractorWork work)
                           throws DatabaseException,
                                  FileNotFoundException

Helps on extracting text from documents

Throws:

DatabaseException

FileNotFoundException

getExtractedText

public String getExtractedText(String uuid)
                        throws PathNotFoundException,
                               DatabaseException

Get extracted text.

Throws:

PathNotFoundException

DatabaseException

getExtractedText

public String getExtractedText(org.hibernate.Session session,
                      String uuid)
                        throws PathNotFoundException,
                               DatabaseException

Get extracted text.

Throws:

PathNotFoundException

DatabaseException

isTextExtracted

public boolean isTextExtracted(String uuid)
                        throws DatabaseException

Check if text has been already extracted.

Throws:

DatabaseException

isValid

public boolean isValid(String uuid)
                throws DatabaseException

Check for a valid document node.

Throws:

DatabaseException

initialize

public void initialize(NodeDocument nDocument,
              boolean initPropGroups)

Force initialization of a proxy

liveEditCancelCheckout

public void liveEditCancelCheckout(String user,
                          String uuid,
                          boolean force)
                            throws PathNotFoundException,
                                   AccessDeniedException,
                                   LockException,
                                   DatabaseException

Cancel checkout and delete temporal file.

Throws:

PathNotFoundException

AccessDeniedException

LockException

DatabaseException