Browse Source

Added table with links and descriptions.

Fixes #53.
Dustin Oprea 11 years ago
parent
commit
0509213a14
1 changed files with 31 additions and 29 deletions
  1. 31 29
      README.md

+ 31 - 29
README.md

@@ -8,32 +8,34 @@ rerun `append_output.sh` to keep the output comments at the bottom up to date.
 
 Current Patterns:
 
-* 3-tier
-* abstract_factory
-* adapter
-* borg
-* bridge
-* builder
-* catalog
-* chain
-* command
-* composite
-* decorator
-* facade
-* factory_method
-* flyweight
-* graph_search
-* iterator
-* mediator
-* memento
-* mvc
-* null
-* observer
-* pool
-* prototype
-* proxy
-* publish_subscribe
-* state
-* strategy
-* template
-* visitor
+| Pattern | Description |
+|:-------:| ----------- |
+| [3-tier](3-tier.py) | data<->business logic<->presentation separation (strict relationships) |
+| [abstract_factory](abstract_factory.py) | use a generic function with specific factories |
+| [adapter](adapter.py) | adapt one interface to another using a whitelist |
+| [borg](borg.py) | a singleton with shared-state among instances |
+| [bridge](bridge.py) | a client-provider middleman to soften interface changes |
+| [builder](builder.py) | call many little discrete methods rather than having a huge number of constructor parameters |
+| [catalog](catalog.py) | general methods will call different specialized methods based on construction parameter |
+| [chain](chain.py) | apply a chain of successive handlers to try and process the data |
+| [command](command.py) | bundle a command and arguments to call later |
+| [composite](composite.py) | encapsulate and provide access to a number of different objects |
+| [decorator](decorator.py) | wrap functionality with other functionality in order to affect outputs |
+| [facade](facade.py) | use one class as an API to a number of others |
+| [factory_method](factory_method.py) | delegate a specialized function/method to create instances |
+| [flyweight](flyweight.py) | transparently reuse existing instances of objects with similar/identical state |
+| [graph_search](graph_search.py) | (graphing algorithms, not design patterns) |
+| [iterator](iterator.py) | structure repeated, identical calls as a generator |
+| [mediator](mediator.py) | an object that knows how to connect other objects and act as a proxy |
+| [memento](memento.py) | generate an opaque token that can be used to go back to a previous state |
+| [mvc](mvc.py) | model<->view<->controller (non-strict relationships) |
+| [null](null.py) | (no clear use in modern Python) |
+| [observer](observer.py) | provide a callback for notification of events/changes to data |
+| [pool](pool.py) | preinstantiate and maintain a group of instances of the same type |
+| [prototype](prototype.py) | use a factory and clones of a prototype for new instances (if instantiation is expensive) |
+| [proxy](proxy.py) | an object funnels operations to something else |
+| [publish_subscribe](publish_subscribe.py) | a source syndicates events/data to 0+ registered listeners |
+| [state](state.py) | logic is org'd into a discrete number of potential states and the next state that can be transitioned to |
+| [strategy](strategy.py) | selectable operations over the same data |
+| [template](template.py) | an object imposes a structure but takes pluggable components |
+| [visitor](visitor.py) | invoke a callback for all items of a collection |