summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristian Mollekopf <chrigi_1@fastmail.fm>2015-11-08 21:07:56 +0100
committerChristian Mollekopf <chrigi_1@fastmail.fm>2015-11-08 21:07:56 +0100
commit790991aa1007d3271d80bc7e77f5b4f86c9bcef0 (patch)
tree5c5f9c8b06157789d5bb0c7a707b04e25018a60e
parentb56df00a4e9a874b96ad53b24a0e3b54e2d967c5 (diff)
downloadsink-790991aa1007d3271d80bc7e77f5b4f86c9bcef0.tar.gz
sink-790991aa1007d3271d80bc7e77f5b4f86c9bcef0.zip
Docs
-rw-r--r--docs/resource.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/resource.md b/docs/resource.md
index 0f3d163..d1b2bbe 100644
--- a/docs/resource.md
+++ b/docs/resource.md
@@ -100,7 +100,7 @@ To avoid building all indexes initially, and assuming not all indexes are necess
100 100
101Building the index on-demand is a matter of replaying the relevant dataset and using the usual indexing methods. This should typically be a process that doesn't take too long, and that provides status information, since it will block the query. 101Building the index on-demand is a matter of replaying the relevant dataset and using the usual indexing methods. This should typically be a process that doesn't take too long, and that provides status information, since it will block the query.
102 102
103The indexes status information can be recorded using the latest revisoin the index has been updated with. 103The indexes status information can be recorded using the latest revision the index has been updated with.
104 104
105## Generic Preprocessors 105## Generic Preprocessors
106Most preprocessors will likely be used by several resources, and are either completely generic, or domain specific (such as only for mail). 106Most preprocessors will likely be used by several resources, and are either completely generic, or domain specific (such as only for mail).
@@ -109,5 +109,10 @@ It is therefore desirable to have default implementations for common preprocesso
109The domain types provide a generic interface to access most properties of the entities, on top of which generic preprocessors can be implemented. 109The domain types provide a generic interface to access most properties of the entities, on top of which generic preprocessors can be implemented.
110It is that way trivial to i.e. implement a preprocessor that populates a hierarchy index of collections. 110It is that way trivial to i.e. implement a preprocessor that populates a hierarchy index of collections.
111 111
112## Preprocessors generating additional entities
113A preprocessor, such as an email threading preprocessors, might generate additional entities (A thread entity is a regular entity, just like the mail that spawned the thread).
114
115In such a case the preprocessor must invoke the complete pipeline for the new entity.
116
112# Pipeline 117# Pipeline
113A pipeline is an assembly of a set of preprocessors with a defined order. A modification is always persisted at the end of the pipeline once all preprocessors have been processed. 118A pipeline is an assembly of a set of preprocessors with a defined order. A modification is always persisted at the end of the pipeline once all preprocessors have been processed.