org.alfresco.filesys.repo

Class ContentSearchContext

java.lang.Object

org.alfresco.jlan.server.filesys.SearchContext

org.alfresco.filesys.repo.ContentSearchContext

All Implemented Interfaces:

InFlightCorrectable

Direct Known Subclasses:

DotDotContentSearchContext

public class ContentSearchContext
extends org.alfresco.jlan.server.filesys.SearchContext
implements InFlightCorrectable

Wrapper for simple XPath searche against the node service. The search is performed statically outside the context instance itself - this class merely maintains the state of the search results across client connections.

Author:

Derek Hulley

Field Summary

Fields

Modifier and Type	Field and Description
static int	LinkFileSize

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ContentSearchContext(CifsHelper cifsHelper, List<org.alfresco.service.cmr.repository.NodeRef> results, String searchStr, org.alfresco.jlan.server.filesys.pseudo.PseudoFileList pseudoList, String relPath, boolean lockedFilesAsOffline) Class constructor

Method Summary

Modifier and Type	Method and Description
protected int	getPseudoListSize() Return the pseudo file list size
protected String	getRelativePath() Return the relative path that is being searched
protected int	getResultsSize() Return the results array size
int	getResumeId() Return the resume id for the current file/directory in the search.
boolean	hasMoreFiles() Determine if there are more files for the active search.
boolean	nextFileInfo(org.alfresco.jlan.server.filesys.FileInfo info) Return file information for the next file in the active search.
String	nextFileName() Return the file name of the next file in the active search.
boolean	restartAt(org.alfresco.jlan.server.filesys.FileInfo info) Restart a search at the specified resume point.
boolean	restartAt(int resumeIdParameter) Restart the current search at the specified file.
protected boolean	returningPseudoFiles() Check if the search is returning pseudo files or real file entries
void	setInFlightCorrector(InFlightCorrector corrector)
String	toString() Return the search as a string

Methods inherited from class org.alfresco.jlan.server.filesys.SearchContext

closeSearch, getDotDotInfo, getDotInfo, getFlags, getMaximumFiles, getSearchString, getTreeId, hasDotFiles, numberOfEntries, setFlags, setMaximumFiles, setSearchString, setTreeId

Methods inherited from class java.lang.Object

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

Field Detail

LinkFileSize

public static final int LinkFileSize

See Also:

Constant Field Values

Constructor Detail

ContentSearchContext

protected ContentSearchContext(CifsHelper cifsHelper,
                               List<org.alfresco.service.cmr.repository.NodeRef> results,
                               String searchStr,
                               org.alfresco.jlan.server.filesys.pseudo.PseudoFileList pseudoList,
                               String relPath,
                               boolean lockedFilesAsOffline)

Class constructor

Parameters:

cifsHelper - Filesystem helper class

results - List of file/folder nodes that match the search pattern

searchStr - Search path

pseudoList - List of pseudo files to be blended into the returned list of files

relPath - Relative path being searched

Method Detail

setInFlightCorrector

public void setInFlightCorrector(InFlightCorrector corrector)

Specified by:

setInFlightCorrector in interface InFlightCorrectable

toString

public String toString()

Return the search as a string

Overrides:

toString in class org.alfresco.jlan.server.filesys.SearchContext

Returns:

String

getResumeId

public int getResumeId()

Return the resume id for the current file/directory in the search.

Specified by:

getResumeId in class org.alfresco.jlan.server.filesys.SearchContext

Returns:

int

hasMoreFiles

public boolean hasMoreFiles()

Determine if there are more files for the active search.

Specified by:

hasMoreFiles in class org.alfresco.jlan.server.filesys.SearchContext

Returns:

boolean

nextFileInfo

public boolean nextFileInfo(org.alfresco.jlan.server.filesys.FileInfo info)

Return file information for the next file in the active search. Returns false if the search is complete.

Specified by:

nextFileInfo in class org.alfresco.jlan.server.filesys.SearchContext

Parameters:

info - FileInfo to return the file information.

Returns:

true if the file information is valid, else false

nextFileName

public String nextFileName()

Return the file name of the next file in the active search. Returns null is the search is complete.

Specified by:

nextFileName in class org.alfresco.jlan.server.filesys.SearchContext

Returns:

String

restartAt

public boolean restartAt(org.alfresco.jlan.server.filesys.FileInfo info)

Restart a search at the specified resume point.

Specified by:

restartAt in class org.alfresco.jlan.server.filesys.SearchContext

Parameters:

info - File to restart the search at.

Returns:

true if the search can be restarted, else false.

restartAt

public boolean restartAt(int resumeIdParameter)

Restart the current search at the specified file.

Specified by:

restartAt in class org.alfresco.jlan.server.filesys.SearchContext

Parameters:

resumeId - Resume point id.

Returns:

true if the search can be restarted, else false.

returningPseudoFiles

protected boolean returningPseudoFiles()

Check if the search is returning pseudo files or real file entries

Returns:

boolean

getRelativePath

protected String getRelativePath()

Return the relative path that is being searched

Returns:

String

getResultsSize

protected int getResultsSize()

Return the results array size

Returns:

int

getPseudoListSize

protected int getPseudoListSize()

Return the pseudo file list size

Returns:

int