com.esri.gpt.control.webharvest.protocol
Interface Protocol

All Known Implementing Classes:

AbstractHTTPHarvestProtocol, ArcGISProtocol, HarvestProtocol, HarvestProtocolAgp, HarvestProtocolAgp2Agp, HarvestProtocolAgs2Agp, HarvestProtocolArcIms, HarvestProtocolAtom, HarvestProtocolCsw, HarvestProtocolDCAT, HarvestProtocolGpt2Agp, HarvestProtocolNone, HarvestProtocolOai, HarvestProtocolResource, HarvestProtocolThredds, HarvestProtocolWaf

public interface Protocol

Protocol.

Method Summary

void	applyAttributeMap(StringAttributeMap attributeMap) Applies protocol attributes map.
StringAttributeMap	extractAttributeMap() Extracts protocol attributes map.
String	getAdHoc() Gets ad-hoc harvesting info.
StringAttributeMap	getAttributeMap() Gets protocol attributes map.
long	getFlags() Gets flag set.
String	getKind() Gets protocol kind.
Executor	newExecutor(DataProcessor dataProcessor, ExecutionUnit unit, IWorker worker) Creates new executor.
QueryBuilder	newQueryBuilder(IterationContext context, String url) Creates new query builder.
void	setAdHoc(String adHoc) Sets ad-hoc info.
void	setAttributeMap(StringAttributeMap attributeMap) Sets protocol attributes map.
void	setFlags(long flags) Sets flag set.

Method Detail

getKind

String getKind()

Gets protocol kind.

Returns:

protocol kind

getAttributeMap

StringAttributeMap getAttributeMap()

Gets protocol attributes map. Used to exchange attributes with the form.

Returns:

attributes map

setAttributeMap

void setAttributeMap(StringAttributeMap attributeMap)

Sets protocol attributes map. Used to exchange attributes with the form.

Parameters:

attributeMap - attributes map

extractAttributeMap

StringAttributeMap extractAttributeMap()

Extracts protocol attributes map. Used saving (typically encrypts user name/password).

Returns:

attributes map

applyAttributeMap

void applyAttributeMap(StringAttributeMap attributeMap)

Applies protocol attributes map. Used loading (typically decrypts user name/password).

Parameters:

attributeMap - attributes map

getFlags

long getFlags()

Gets flag set.

Returns:

flags set

setFlags

void setFlags(long flags)

Sets flag set.

Parameters:

flags - flag set

newQueryBuilder

QueryBuilder newQueryBuilder(IterationContext context,
                             String url)

Creates new query builder.

Parameters:

context - iteration context

url - url

Returns:

query builder

newExecutor

Executor newExecutor(DataProcessor dataProcessor,
                     ExecutionUnit unit,
                     IWorker worker)

Creates new executor.

Parameters:

dataProcessor - data processor

unit - execution unit

worker - worker

Returns:

executor

getAdHoc

String getAdHoc()

Gets ad-hoc harvesting info.

Ad-hoc information allows to store precise definition or pattern of the time when harvesting should occur. Ad-hoc is a pipe (|) separated set of time definitions. Currently, the following syntax is supported:

• hh:mm - daily at a certain time, for example: 10:05 (every day at 10:05)
• <day of the week>,hh:mm - every specified day of the week at a certain time, for example: SUNDAY,10:05 (every Sunday at 10:05)
• <day of the month>,hh:mm - every specified day of the month at a certain time, for example: 7,10:05 (every seventh day of the month at 10:05
• <n-th day of the week>,<day of the week>,hh:mm - every specified day of the week at a certain time, for example: 1,MONDAY,10:05 (every first Monday of the month at 10:05)
• yyyy-MM-ddThh:mm - at the specific date and time, for example: 2013-03-17T10:05 (precisely on 17-th of March, 2013 at 10:05)

Returns:

ad-hoc

setAdHoc

void setAdHoc(String adHoc)

Sets ad-hoc info.

Parameters:

adHoc - ad-hoc info

See Also:

setAdHoc(java.lang.String)