org.archive.crawler.spring

Class SheetOverlaysManager

java.lang.Object

org.archive.crawler.spring.SheetOverlaysManager

All Implemented Interfaces:

EventListener, OverlayMapsSource, org.springframework.beans.factory.BeanFactoryAware, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

public class SheetOverlaysManager
extends Object
implements org.springframework.beans.factory.BeanFactoryAware, OverlayMapsSource, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

Manager which marks-up CrawlURIs with the names of all applicable Sheets, and returns overlay maps by name.

Contributor:

gojomo

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.beans.factory.BeanFactory	beanFactory
protected SortedSet<DecideRuledSheetAssociation>	ruleAssociations all SheetAssociations by DecideRule evaluation
protected NavigableMap<String,List<String>>	sheetNamesBySurt
protected Map<String,Sheet>	sheetsByName all sheets by (bean)name

Constructor Summary

Constructors

Constructor and Description
SheetOverlaysManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	addRuleAssociation(DecideRuledSheetAssociation assoc)
void	addRuleAssociations(Set<DecideRuledSheetAssociation> associations) Collect all rule-based SheetAssociations.
void	addSurtAssociation(String prefix, String sheetName)
void	addSurtAssociations(List<SurtPrefixesSheetAssociation> associations) Collect all SURT-based SheetAssociations.
void	addSurtsAssociation(SurtPrefixesSheetAssociation assoc) Add an individual surtsAssociation to the sheetNamesBySurt map.
void	applyOverlaysTo(CrawlURI curi) Apply the proper overlays (by Sheet beanName) to the given CrawlURI, according to configured associations.
boolean	deleteSheet(String sheetName) Delete a named sheet from all associations and the master named sheets map.
Sheet	getOrCreateSheet(String name) Get a Sheet of the given name, or create if it does not already exist.
Map<String,Object>	getOverlayMap(String name) Retrieve the named overlay Map.
SortedSet<DecideRuledSheetAssociation>	getRuleAssociations() All DecideRuledSheetAssociations, in Ordered order
Map<String,Sheet>	getSheetsByName() Sheets, by name; starts with all autowired Sheets but others may be added by other means (mid-crawl reconfiguration).
NavigableMap<String,List<String>>	getSheetsNamesBySurt() Sheet names, by the SURT prefix to which they should be applied.
void	onApplicationEvent(org.springframework.context.ApplicationEvent event) Ensure all sheets are 'primed' after the entire ApplicatiotnContext is assembled.
Object	putSheetOverlay(String sheetName, String beanPath, Object value) Add to named sheet an overlay of the given bean-path and new value.
Object	removeSheetOverlay(String sheetName, String beanPath) Remove the given bean-path overlay in the named sheet.
boolean	removeSurtAssociation(String prefix, String sheetName)
void	setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
void	setSheetsByName(Map<String,Sheet> map) Collect all Sheets, by beanName.

Methods inherited from class java.lang.Object

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

Field Detail

beanFactory

protected org.springframework.beans.factory.BeanFactory beanFactory

ruleAssociations

protected SortedSet<DecideRuledSheetAssociation> ruleAssociations

all SheetAssociations by DecideRule evaluation

sheetNamesBySurt

protected NavigableMap<String,List<String>> sheetNamesBySurt

sheetsByName

protected Map<String,Sheet> sheetsByName

all sheets by (bean)name

Constructor Detail

SheetOverlaysManager

public SheetOverlaysManager()

Method Detail

setBeanFactory

public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
                    throws org.springframework.beans.BeansException

Specified by:

setBeanFactory in interface org.springframework.beans.factory.BeanFactoryAware

Throws:

org.springframework.beans.BeansException

setSheetsByName

public void setSheetsByName(Map<String,Sheet> map)

Collect all Sheets, by beanName.

Parameters:

map -

getSheetsByName

public Map<String,Sheet> getSheetsByName()

Sheets, by name; starts with all autowired Sheets but others may be added by other means (mid-crawl reconfiguration).

Returns:

map of Sheets by their String name

getRuleAssociations

public SortedSet<DecideRuledSheetAssociation> getRuleAssociations()

All DecideRuledSheetAssociations, in Ordered order

Returns:

set of DecideRuledSheetAssociation

getSheetsNamesBySurt

public NavigableMap<String,List<String>> getSheetsNamesBySurt()

Sheet names, by the SURT prefix to which they should be applied.

Returns:

map of Sheet names by their configured SURT

addRuleAssociations

public void addRuleAssociations(Set<DecideRuledSheetAssociation> associations)

Collect all rule-based SheetAssociations. Typically autowired from the set of all DecideRuledSheetAssociation instances.

Parameters:

ruleSheets -

addRuleAssociation

public void addRuleAssociation(DecideRuledSheetAssociation assoc)

addSurtAssociations

public void addSurtAssociations(List<SurtPrefixesSheetAssociation> associations)

Collect all SURT-based SheetAssociations. Typically autowired from the set of all SurtPrefixesSheetAssociation instances declared in the initial configuration.

Parameters:

surtSheets -

addSurtAssociation

public void addSurtAssociation(String prefix,
                      String sheetName)

removeSurtAssociation

public boolean removeSurtAssociation(String prefix,
                            String sheetName)

addSurtsAssociation

public void addSurtsAssociation(SurtPrefixesSheetAssociation assoc)

Add an individual surtsAssociation to the sheetNamesBySurt map.

getOverlayMap

public Map<String,Object> getOverlayMap(String name)

Retrieve the named overlay Map.

Specified by:

getOverlayMap in interface OverlayMapsSource

See Also:

OverlayMapsSource.getOverlayMap(java.lang.String)

onApplicationEvent

public void onApplicationEvent(org.springframework.context.ApplicationEvent event)

Ensure all sheets are 'primed' after the entire ApplicatiotnContext is assembled. This ensures target HasKeyedProperties beans know any long paths by which their properties are addressed, and handles (by either PropertyEditor-conversion or a fast-failure) any type-mismatches between overlay values and their target properties.

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

See Also:

ApplicationListener.onApplicationEvent(org.springframework.context.ApplicationEvent)

putSheetOverlay

public Object putSheetOverlay(String sheetName,
                     String beanPath,
                     Object value)

Add to named sheet an overlay of the given bean-path and new value. Creates the sheet if it does not already exist; re-primes the sheet after the change to inform any targeted beans of new external paths. Only if/when the sheet is applied via associations will the overlay have a noticeably effect. Inserting/mutating/priming sheets should only be done in a paused crawl.

Parameters:

sheetName - sheet name to change (or create)

beanPath - target bean-path of overlay

value - new value

Returns:

old value, if any

removeSheetOverlay

public Object removeSheetOverlay(String sheetName,
                        String beanPath)

Remove the given bean-path overlay in the named sheet.

Parameters:

sheetName - sheet name from which to remove overlay

beanPath - overlay to remove

Returns:

previous overlay value, if any

deleteSheet

public boolean deleteSheet(String sheetName)

Delete a named sheet from all associations and the master named sheets map.

Parameters:

sheetName - sheet name to delete

Returns:

true if any associations/sheet actually deleted

getOrCreateSheet

public Sheet getOrCreateSheet(String name)

Get a Sheet of the given name, or create if it does not already exist. Provided for convenience of creating Sheet instances after the container has been built. To have effect as an overlay, the returned Sheet must be: (1) filled with overlay entries, where the key is a full bean-path and the value the alternate overlay value; (2) primed via the prime() method, which will throw an exception if the target bean-path does not address a compatible overlayable value; (3) associated to some URIs, by the addSurtAssociation or addRuledAssociation methods

Parameters:

name - Sheet name to create; must be unique

Returns:

created Sheet

applyOverlaysTo

public void applyOverlaysTo(CrawlURI curi)

Apply the proper overlays (by Sheet beanName) to the given CrawlURI, according to configured associations. TODO: add guard against redundant application more than once? TODO: add mechanism for reapplying overlays after settings change?

Parameters:

curi -