Index (Folder Resource Iterator 1.0 API)

A C D F G H I K L M N O Q R S T U

A

addToMap(String, Iterator<?>) - Method in class org.ow2.weblab.services.iterator.InterfacesMappingSingleton: Add to the configuration map this mapping between usageContext and fileIterator.

C

C_CLEAR_CONF - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be printed when reset configuration is called with an null usageContext.
C_CONF - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be printed when reset configuration is called with a usageContext.
C_CONF_ARGS_NULL - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be added in the exception when the configure args is null.
C_CONF_EXIST - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the warning message to be printed when configuration is called with a usageContext already configured.
C_CONF_NULL - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be added in the exception when the configuration in configure args is null.
C_FILE_NOT_DIRECTORY - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be added in the exception when the default path is not a directory.
C_FILE_NOT_READABLE - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be added in the exception when the default path is not a readable.
C_FOLDER_NOT_EXIST - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be added in the exception when the default path does not exist.
C_MORE_THAN_ONE_CONF - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the warning message to be printed when more than one configuration is found in the PoK.
C_MORE_THAN_ONE_FOLDER - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the warning message to be printed when the configuration contains more than one folder to crawl.
C_NO_CONFIG - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be added in the exception when the configuration is empty.
C_NO_FOLDER - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be added in the exception when the configuration does not contain a folder to crawl.
C_NO_TYPE - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the warning message to be printed when the RDF type of the configuration is not found.
C_NO_UC - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the warning message to be printed when the configuration instance is not linked to the right usageContext.
C_RESET_CONF_NULL - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be added in the exception when the reset configuration args is null.
C_RESET_UC - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be printed when reset configuration is called with a usageContext.
C_STARTED - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be printed when folder resource configuration is started.
checkFolder(String, String) - Static method in class org.ow2.weblab.services.iterator.FolderResourceConf: Checks that the given path denotes an existing readable folder.
clearMap() - Method in class org.ow2.weblab.services.iterator.InterfacesMappingSingleton: Removes every mapping from the configuration map.
configuration - Variable in class org.ow2.weblab.services.iterator.FolderResourceConf: The bean that contains the configuration of the service.
configuration - Variable in class org.ow2.weblab.services.iterator.FolderResourceQM: The bean that contains the configuration of the service.
ConfigurationBean - Class in org.ow2.weblab.services.iterator: This class is a bean holder for the configuration of FolderResourceQM and FolderResourceConf.
ConfigurationBean() - Constructor for class org.ow2.weblab.services.iterator.ConfigurationBean
configurationType - Variable in class org.ow2.weblab.services.iterator.ConfigurationBean: The URI of the RDF type for an instance of configuration.
configure(ConfigureArgs) - Method in class org.ow2.weblab.services.iterator.FolderResourceConf

D

DEFAULT_CONF_ONTO - Static variable in class org.ow2.weblab.services.iterator.ConfigurationBean: Default namespace of the configuration ontology used here.
DEFAULT_CONF_TYPE - Static variable in class org.ow2.weblab.services.iterator.ConfigurationBean: Default URI of the Configuration type.
DEFAULT_HAS_CONFIGURATION_URI - Static variable in class org.ow2.weblab.services.iterator.ConfigurationBean: Default property that links a service URI with an instance of configuration.
DEFAULT_HAS_FOLDER_TO_CRAWL - Static variable in class org.ow2.weblab.services.iterator.ConfigurationBean: Default property that links an instance of configuration with is folder to crawl.
DEFAULT_IS_LINKED_TO_CONTEXT - Static variable in class org.ow2.weblab.services.iterator.ConfigurationBean: Default property that links an instance of configuration with its usageContext.
DEFAULT_SERVICE_URI - Static variable in class org.ow2.weblab.services.iterator.ConfigurationBean: The default service URI
defaultPath - Variable in class org.ow2.weblab.services.iterator.ConfigurationBean: The default path to be used by null or empty usageContext.
directoryFilter - Variable in class org.ow2.weblab.services.iterator.ConfigurationBean: The filter to be applied on each directory found while iterating.

F

fileFilter - Variable in class org.ow2.weblab.services.iterator.ConfigurationBean: The filter to be applied on each file found while iterating.
FolderResourceConf - Class in org.ow2.weblab.services.iterator: This class is a the Configurable part of the FolderResource service.
FolderResourceConf(ConfigurationBean) - Constructor for class org.ow2.weblab.services.iterator.FolderResourceConf: The constructor that takes as parameter the same bean than the queue manager to be associated with.
FolderResourceQM - Class in org.ow2.weblab.services.iterator: This class is a the QueueManager part of the FolderResource service.
FolderResourceQM(ConfigurationBean) - Constructor for class org.ow2.weblab.services.iterator.FolderResourceQM: The constructor for the realisation of the QueueManager interface for a FolderResource service.

G

getConfigurationType() - Method in class org.ow2.weblab.services.iterator.ConfigurationBean
getDefaultFolder() - Method in class org.ow2.weblab.services.iterator.ConfigurationBean
getDefaultPath() - Method in class org.ow2.weblab.services.iterator.ConfigurationBean
getDirectoryFilter() - Method in class org.ow2.weblab.services.iterator.ConfigurationBean
getFileFilter() - Method in class org.ow2.weblab.services.iterator.ConfigurationBean
getHasConfiguration() - Method in class org.ow2.weblab.services.iterator.ConfigurationBean
getHasFolderToCrawl() - Method in class org.ow2.weblab.services.iterator.ConfigurationBean
getInstance() - Static method in class org.ow2.weblab.services.iterator.InterfacesMappingSingleton: Get the existing instance of MappingSingleton or initialise it.
getIsLinkedToContext() - Method in class org.ow2.weblab.services.iterator.ConfigurationBean
getIterator(String) - Method in class org.ow2.weblab.services.iterator.InterfacesMappingSingleton: Get the iterator associated to this usageContext or null if not configured.
getServiceUri() - Method in class org.ow2.weblab.services.iterator.ConfigurationBean
getString(String) - Static method in class org.ow2.weblab.services.iterator.messages.Messages: Lookup in the ResourceBundle for the key in parameter.
getString(String, Object...) - Static method in class org.ow2.weblab.services.iterator.messages.Messages: Lookup in the ResourceBundle for the key in parameter.

H

hasConfiguration - Variable in class org.ow2.weblab.services.iterator.ConfigurationBean: The URI of the property that links a service URI with an instance of configuration.
hasFolderToCrawl - Variable in class org.ow2.weblab.services.iterator.ConfigurationBean: The URI of the property that links an instance of configuration with the folder to crawl.

I

IMS_INITIALISED - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be printed with the configuration singleton is initialised.
InterfacesMappingSingleton - Class in org.ow2.weblab.services.iterator: This class is a singleton in charge of the mapping between the two interfaces of the service (Configurable and QueueManager).
isConfigured(String) - Method in class org.ow2.weblab.services.iterator.InterfacesMappingSingleton: Check if the usageContext in parameter has been configured.
isLinkedToContext - Variable in class org.ow2.weblab.services.iterator.ConfigurationBean: The URI of the property that links an instance of configuration with it's usageContext.
isRemoveFiles() - Method in class org.ow2.weblab.services.iterator.ConfigurationBean
isUseDefaultPathForNotConfigured() - Method in class org.ow2.weblab.services.iterator.ConfigurationBean

K

Keys - Class in org.ow2.weblab.services.iterator.messages: This class is an holder for every messages using in the service.

L

logger - Variable in class org.ow2.weblab.services.iterator.FolderResourceConf: The logger used inside.
logger - Variable in class org.ow2.weblab.services.iterator.FolderResourceQM: The logger used inside

M

M_MESSAGE_NOT_FOUND - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the warning message to be printed when a message is not found.
mapping - Variable in class org.ow2.weblab.services.iterator.FolderResourceConf: The class that maps Configurable with QueueManager.
mapping - Variable in class org.ow2.weblab.services.iterator.FolderResourceQM: The mapping between Configurable and QueueManager.
marshaller - Variable in class org.ow2.weblab.services.iterator.FolderResourceQM: The (un)marshaller used to read
Messages - Class in org.ow2.weblab.services.iterator.messages: This class enable to load messages from the resource bundle associated to this class canonical name.

N

nextResource(NextResourceArgs) - Method in class org.ow2.weblab.services.iterator.FolderResourceQM

O

org.ow2.weblab.services.iterator - package org.ow2.weblab.services.iterator
org.ow2.weblab.services.iterator.messages - package org.ow2.weblab.services.iterator.messages

Q

QM_ARGS_NULL - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be added in the exception when nextResourceArgs is null.
QM_EMPTY - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be added in the exception when no more resources are in the iterator.
QM_FILE_NOT_EXIST - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be added in the exception when the iterator returns a file that does not exists.
QM_FILE_NOT_FILE - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be added in the exception when the iterator returns a file that is not a file.
QM_FILE_NOT_READABLE - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be added in the exception when the iterator returns a file that is not readable.
QM_MARSHAL_ERROR - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the warning message to be printed when logging the resource fails.
QM_NEXT_RESOURCE_CALLED - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be printed when the service next resource method is called.
QM_NOT_A_FILE - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be added in the exception when the iterator returns an object that is not a file.
QM_NOT_CONFIGURED - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be added in the exception when an unknown usageContext is required.
QM_PATH_NULL - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be added in the exception when the default path is null.
QM_STARTED - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be printed when the service has started.
QM_UNMARSHAL_ERROR - Static variable in class org.ow2.weblab.services.iterator.messages.Keys: The key of the message to be added in the exception when the iterator returns a file which unmarshaling fails.

R

readConfigPoK(String, PieceOfKnowledge) - Method in class org.ow2.weblab.services.iterator.FolderResourceConf: Reads the PieceOfKnowledge in parameter to retrieve path to the folder to be crawled.
removeConfiguration(String) - Method in class org.ow2.weblab.services.iterator.InterfacesMappingSingleton: Removes usageContext from the configuration map.
removeFiles - Variable in class org.ow2.weblab.services.iterator.ConfigurationBean: Whether to remove files after accessing them from the iterator.
resetConfiguration(ResetConfigurationArgs) - Method in class org.ow2.weblab.services.iterator.FolderResourceConf

S

serviceUri - Variable in class org.ow2.weblab.services.iterator.ConfigurationBean: The URI of the service.
setConfigurationType(String) - Method in class org.ow2.weblab.services.iterator.ConfigurationBean
setDefaultPath(String) - Method in class org.ow2.weblab.services.iterator.ConfigurationBean
setDirectoryFilter(IOFileFilter) - Method in class org.ow2.weblab.services.iterator.ConfigurationBean
setFileFilter(IOFileFilter) - Method in class org.ow2.weblab.services.iterator.ConfigurationBean
setHasConfiguration(String) - Method in class org.ow2.weblab.services.iterator.ConfigurationBean
setHasFolderToCrawl(String) - Method in class org.ow2.weblab.services.iterator.ConfigurationBean
setIsLinkedToContext(String) - Method in class org.ow2.weblab.services.iterator.ConfigurationBean
setRemoveFiles(boolean) - Method in class org.ow2.weblab.services.iterator.ConfigurationBean
setServiceUri(String) - Method in class org.ow2.weblab.services.iterator.ConfigurationBean
setUseDefaultPathForNotConfigured(boolean) - Method in class org.ow2.weblab.services.iterator.ConfigurationBean

T

toString() - Method in class org.ow2.weblab.services.iterator.ConfigurationBean

U

useDefaultPathForNotConfigured - Variable in class org.ow2.weblab.services.iterator.ConfigurationBean: Whether the defaultPath should also be used by unknown usageContexts, instead of throwing a ServiceNotConfiguredException.

A C D F G H I K L M N O Q R S T U