org.alfresco.jlan.server.filesys.pseudo

Class PseudoSearchContext

java.lang.Object

org.alfresco.jlan.server.filesys.SearchContext

org.alfresco.jlan.server.filesys.pseudo.PseudoSearchContext

public abstract class PseudoSearchContext
extends SearchContext

Pseudo File Search Context Class

Search context implementation that blends a list of pseudo files/folders into a folder search.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	m_index

Constructor Summary

Constructors

Constructor and Description
PseudoSearchContext(java.lang.String relPath) Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
int	getResumeId() Return the resume id for the current file/directory in the search.
boolean	hasMorePseudoFiles() Determine if there are more files for the active search.
boolean	hasPseudoFiles() Check if there are pseudo files to be blended into the search results
boolean	nextPseudoFileInfo(FileInfo info) Return file information for the next pseudo file in the active search.
java.lang.String	nextPseudoFileName() Return the file name of the next pseudo file in the active search.
boolean	restartAtPseudoFile(FileInfo info) Restart a search at the specified pseudo file resume point.
boolean	restartAtPseudoFile(int resumeId) Restart the current search at the specified pseudo file.
void	setPseudoFileList(PseudoFileList pseudoList) Set the pseudo file list for the search

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

closeSearch, getDotDotInfo, getDotInfo, getFlags, getMaximumFiles, getSearchString, getTreeId, hasDotFiles, hasMoreFiles, nextFileInfo, nextFileName, numberOfEntries, restartAt, restartAt, setFlags, setMaximumFiles, setSearchString, setTreeId, toString

Methods inherited from class java.lang.Object

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

Field Detail

m_index

protected int m_index

Constructor Detail

PseudoSearchContext

public PseudoSearchContext(java.lang.String relPath)

Class constructor

Parameters:

relPath - String

Method Detail

hasPseudoFiles

public final boolean hasPseudoFiles()

Check if there are pseudo files to be blended into the search results

Returns:

boolean

setPseudoFileList

public final void setPseudoFileList(PseudoFileList pseudoList)

Set the pseudo file list for the search

Parameters:

pseudoList - PseudoFileList

getResumeId

public int getResumeId()

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

Specified by:

getResumeId in class SearchContext

Returns:

int

hasMorePseudoFiles

public boolean hasMorePseudoFiles()

Determine if there are more files for the active search.

Returns:

boolean

nextPseudoFileInfo

public boolean nextPseudoFileInfo(FileInfo info)

Return file information for the next pseudo file in the active search. Returns false if there are no more pseudo files/folders to be returned

Parameters:

info - FileInfo to return the file information.

Returns:

true if the file information is valid, else false

nextPseudoFileName

public java.lang.String nextPseudoFileName()

Return the file name of the next pseudo file in the active search. Returns null is there are no more pseudo file names to return

Returns:

String

restartAtPseudoFile

public boolean restartAtPseudoFile(FileInfo info)

Restart a search at the specified pseudo file resume point.

Parameters:

info - FileInfo

Returns:

true if the search can be restarted, else false.

restartAtPseudoFile

public boolean restartAtPseudoFile(int resumeId)

Restart the current search at the specified pseudo file.

Parameters:

resumeId - int

Returns:

true if the search can be restarted, else false.