1 Archetypes, Color, and the

Domain-Neutral Component

Pink: Its my favorite crayon.

Aerosmith

Black-and-white conveys basic information. Color reaches out and

grabs you.
Just as the transition from black-and-white photography to color is
so profound, the transition from black-and-white modeling to color is an
awesome one.
Welcome to the world of modeling in color, with archetypes, a
domain-neutral component, and 61 domain-specific components.
In this chapter, youll learn and apply archetypes, color, and the
domain-neutral component. In Chapters 25, youll read and apply a
wide variety of domain-specific components. In Chapter 6, youll dis-
cover feature-driven development, the process for putting all of this into
best practice.
How does Java fit in? Many of the model shapes are Java inspired.
Youll find composition rather than inheritance. Youll also see a judicious
use of interface plug-in pointsfor added flexibility. In addition, the CD
includes all of the models plus Java skeleton source code, ready for design
by feature, build by feature expansion, as described in Chapter 6.
Weve developed this book as a front-end companion to Java Design.
That book delivers specific strategies for designing with composition,
designing with threads, and designing with notification.
Throughout this book, we use Unified Modeling Language (UML)
notation. The class-diagram notation and conventions we use in this book
are shown in Figure 1-1. The sequence-diagram notation and conventions
we use are shown in Figure 1-2. We suggest you scan those figures now,
then refer back to them from time to time.
 Class1
A class with an italicized
attribute name is an abstract class
(a class without objects).
method

Inheritance link
(points from
specialization to
generalization)

The 0..* cardinality

indicates that a
class2 object holds
a collection of some
number of class3
objects. Class3
Class2
1 association link 0..* attribute
attribute link role method
The 1 cardinality
method
indicates that a 1
class3 object holds
exactly one class2
Usual
object.
cardinalities
for association
aggregation link
and aggregation
links:
0..1 1
0..* 1..*
Component
This is a UML package.
Convention: use it as a 0..*
component symbol. Class4 interface
Interface1
attribute
method Implements link
method
(points from an
implementer to
an interface)

An interface specifies
method signatures. -->

<--An implementer
implement the corres-
ponding methods.
A.

Class7 Class8 0..*

Association link Aggregation link
attribute 0..* attribute smaller from one object
0..* from one object
actual to others in the method to others in the
same class (with same class (with
0..1 plan 0..* 0..1 larger
example "link role" example "link role"
labels) labels)

0..1
...Component.Class9
<<text label, called a stereotype>>
0..1 1 0..* attribute
Class6
method
attribute
1
method 0..*

0..* ...Component.Class10

0..1
An underlined method is a
Class5
static method (class method), a
attribute method performed by the class
method rather than by the objects in
classMethod the class. (Such methods often
delegate work to a corresponding
data management object.)

Convention: A clipped
A Class5 object might class symbol indicates
hold an Interface2 the class is from another
implementer. component. The symbol
0..1 includes attributes and
interface methods when helpful
Interface2 in understanding the
component under
method consideration.
B.
FIGURE 1-1 Class-diagram notation and conventions. 1
2 Java Modeling in Color with UML

A sequence begins aSender anObject2 anObject3 The box is an object.

with a sender, some ...Class2 ...Class3 Inside: object name,
object that invokes then class name.
the initial method.

1: method
The arrows are messages,
2: method
from sender to receiver
Time moves
(and back again).
down the page;
message arrows
may travel left to A clipped arrowhead
3: method
right or right to left. indicates an asynchronous
4: 'getAttribute' message.

A message name in single quotes

The wide bars
is a comment; corresponding
are activation bars,
class diagram(s) won't include
showing when an
a corresponding method for it.
object is active.
Most common use: getters and setters.

This is a self-delegation 5: method The vertical dashed lines

message. The object are lifelines, indicating
invokes one of its own the life of the object
methods. over time.

Convention: Use "FOR each" Convention: Use IF and ELSE Convention: Use notes to list
notes to indicate iteration (rather notes for conditions (rather than arguments for messages that
than a UML asterisk, limited to UML brackets; need room for need them (helps keep message-
a single message-send). writing the condition). arrow labels from becoming too long).

FIGURE 1-2. Sequence-diagram notation and conventions

1.1 ARCHETYPES
Now lets turn our attention to this chapters first major topic: archetypes.
Heres the concept we want to communicate:

A form or template for one of a small number of class categories. It

specifies attributes, links, methods, plug-in points, and interactions
that are typical for classes in that category.

Which of the following is the better term for this concept?

Stereotype
1. An unvarying model, as though cast from a mold
2. A text tag for annotating a UML diagram element
3. A broad categorization of classes

Archetype
A form from which all things of the same kind more or less follow.
[DERIVED FROM WEBSTER75 AND HAYAKAWA68]
 Archetypes, Color, and the Domain-Neutral Component 3

Its a fact. Archetype says it best. An archetype is a form from which all
classes of the same kind more or less followincluding attributes, links,
methods, plug-in points, and interactions.1
Yet which archetypes prove most useful in building better models?
Weve developed hundreds of models in dozens of business and engi-
neering domains. Along the way, we continually looked for ways to
abstract up to a domain-neutral componenta small model of arche-
types that we could apply again and again in our workshops and men-
toring assignments. Why? We felt we could teach more in less time and
accomplish more in less time. Better for our clients, more interesting for
us, win-win.
Over time, weve discovered four interconnected archetypes that
form a domain-neutral component:

1. The moment-interval archetype

2. The role archetype
3. The catalog-entry-like description archetype
4. The party, place or thing archetype

Wed like to acknowledge that Peter Coad and Mark Mayfield laid
the early groundwork for these four archetypes, first described in [Coad92]
and later extended with David North in [Coad9597].

1.1.1 The Moment-Interval Archetype

The first archetype in importance is a moment in time or an interval of
time. It represents something that one needs to work with and track for
business or legal reasons, something that occurs at a moment in time or
over an interval of time. For short, we call it a moment-interval to help
remind us that we are looking for either a moment or an interval of
importance in the problem domain.
A sale is made at a moment in timethe date and time of that sale.
A rental happens over an interval of time, from checkout to return.
A reservation occurs over an interval of time, from the time that it is made
until the time it is used, canceled, or expires.
A sale could even be an interval of time, if you need to track the
duration of the sales process itself, perhaps for performance assessment.
Whats important is that you recognize it is one of these two,
moment or interval, rather than which one of the two it is. So we estab-
lish it as one archetype, moment-interval.

1
Archetypes are forms that are more or less followed. The more or less aspect is essential.
In contrast, stereotypes are unvarying. Also in contrast, inheritance and interfaces specify
names that must be followed rather than more or less followed.
4 Java Modeling in Color with UML

1.1.1.1 Using Archetypes to Identify Classes and Much More

In any domain, one can look for moment-intervals and begin building a
model. In material-resource management, we can move from request to
RFQ to PO to delivery to invoice. In manufacturing management, we can
move from a planned process and its steps to an actual process and its steps.
So one of the ways that archetypes help in guiding model building
is in identifying classes that need to be included in the model.
Yet archetypes are more than simply a categorization of classes. They
are also a categorization of the responsibilities (the attributes, links, meth-
ods, plug-in points, and interactions) that such classes usually have.

1.1.1.2 Labeling an Archetype

What we need is a text tag, so we can indicate which archetype we are
applying when establishing a class. In UML, that text tag is called a stereo-
type, an extension mechanism within that notation (Figure 1-3).
The problem is that text tags like <<moment-interval>> hide some
very important meaning in a rather plain and simple text label. In a fam-
ily of diagrams, that little label is lost in the noise as it begins to look like
all the other labels. And that is too bad; expressing the archetype is far
more important than it would be getting credit for. It would be nice if one
could give this added layer of information added punch, so it could:

grab your attention to work on that part of the diagram first,

help you discover a progression of moment-intervals over time,
guide you in linking other classes into the moment-interval you

are working with, and

quietly move you to considering what is linked to that moment-

interval and how it works with others to get things done.

Expressing archetypes with color is the extra dimension, the added

punch that does all that and more.

1.1.1.3 Implementing Archetypes

What does an archetype look like in source code?
An archetype describes a model for classes within that archetype to
more or less follow. Its the more or less aspect that is important here.

<<moment-interval>>
Sale
number
date
calcTotal

FIGURE 1-3. Using a

UML text tag to indicate
a moment-interval.
 Archetypes, Color, and the Domain-Neutral Component 5

Could one implement an archetype as a superclass and then inherit

from it? No! Heres why: The very nature of an archetype is that each and
every class that follows an archetype only more or less follows it.
Inheritance is far too rigid for what archetypes are all about, what they
need to express.
The other way to implement an archetype is by using a keyword-
coded comment, one that modeling tools can recognize and use effec-
tively. In Java, we do this with a javadoc-style comment, using a coded
keyword. For example, heres such a comment with an embedded key-
word (following the @ symbol):

/** @archetype moment-interval*/

public class Sale {
public BigDecimal calcTotal(){...
}
private int number;
private Date date;
}

That gets the job done nicely.

1.1.2 The Role Archetype

The second archetype in importance is a role. A role is a way of partici-
pation by a person, place, or thing.
Another way to say this is that a role is a way of participation by a
party (person or organization), place, or thing. We like this better, since
many times a person or an organization is eligible to play the same role
(for example, owner) within a problem domain that we are working in.
Often, a moment-interval has parts, called moment-interval details. Think
of them as being a little piece of a moment-interval, something it needs
to do its job.
So we model the role player (a party, place, or thing) as well as the
role (the hat that the party, place, or thing is wearing). The role player
captures core attributes and behaviors that apply no matter what combi-
nation of hats it might be wearing. For person, that often includes attrib-
utes like legal name and date of birth. It also includes methods that
enforce business rules across the collection of roles being played. For
example, a method authorized for in a person object interacts with each
role; then it applies rules across that collection of roles to determine if a
person is authorized to take a given action (Figure 1-4).
Party, person, and organization roles are the norm. Occasionally
youll find place and thing roles too (for example, a product and its two
roles, product in a sales process and product in use).

1.1.3 The Description Archetype

The third archetype is a description. More specifically, its a catalog-entry-
like description. It is a collection of values that apply again and again. It
6 Java Modeling in Color with UML

<<role>>
Cashier
<<party>>
Person authorizedFor
legalName
dateOfBirth <<role>>
authorizedFor Owner

authorizedFor

FIGURE 1-4. A party and its roles.

also provides behavior across the collection of all things that correspond
to its description.
For example, your red pickup is a vehicle; its a thing with its own ser-
ial number (called a vehicle identification number), purchase date, color,
and odometer reading. The corresponding catalog-entry-like description is
vehicle description; it establishes manufacturer, model number, date of man-
ufacture, and available colors; it also is a good place to locate business-related
methods like, how many of these trucks are in good working order?

1.1.4 The Party, Place, or Thing Archetype

A party (meaning a person or an organization), place, or thing is some-
one or something who plays different roles. A person might be both an
employee and a customer. A place might be both a retail outlet and a
wholesale outlet. A thing might play one role in a manufacturing process
and a different role in a purchasing process.

1.2 COLOR
In September of 1997, we started building models with four colors of Post-
it Notes: pink, yellow, green, and blueone for each archetype. Developers
and domain experts new to model building on the team commented a
number of times along the way, But how could you possibly build effec-
tive models without color? That caught our attention! So we developed
this technique in practice, published initial findings [Coad97a], and pre-
sented this approach in an OOPSLA 97 tutorial [Coad97b].
As is often the case, practice preceded theory. Seeing these ideas work
so well in practice, we began investigating color and why it appears to
have such a profound effect on building better models.

1.2.1 Why Use Color?

Why use color in component models? Color gives us a way to encode
additional layers of information. The wise use of color increases the
amount of content we can express.
 Archetypes, Color, and the Domain-Neutral Component 7

More importantly, one can use color to add layers of new content to
models. Those layers are visible from a distance, so that big picture
model content comes across even before one starts reading the details.
We call this effect spatial layering; it means that a model is capable of
delivering an overview and a detailed view all within itself, without need-
ing to break visual context by jumping to some other representation.
Color makes spatial layering possible.

Among the most powerful devices for reducing noise and enriching
the content of displays is the technique of layering and separation,
visually stratifying various aspects of the data. [He then describes
how to do this: use distinctions in shape, lightness, size, and espe-
cially color.]
EDWARD R. TUFTE [TUFTE90]

Hence, we can use color to enrich the content of models. In fact, we

can apply color to achieve four objectives:

The fundamental uses of color in information design: to label (color

as a noun), to measure (color as a quantity), to represent or imitate
reality (color as a representation), and to enliven or decorate (color
as beauty).
EDWARD R. TUFTE [TUFTE90]

What this means to modeling is that we can use color to:

label added layers of information (for example, layers of classes

with similar characteristics),
indicate the progression of time (for example, one might use dif-
ferent shades of lightness to show such a progression),
represent key categories of information within a model, and
add visual impact to the model.

Added visual impact is important. Modeling is by its very nature a

visually oriented activity. Those with strong spatial intelligence are espe-
cially drawn to model building and model reading.

Spatial knowledge can serve a variety of scientific ends, a useful tool,

an aid to thinking, a way of capturing information, a way of for-
mulating problems, or the very means of solving the problem.
HOWARD GARDNER [GARDNER83]

This ability to idealize results, to see through the mess of real-life

observations to what ought to be there, is one of the marks of genius.
ROBERT SCOTT ROOT-BERNSTEIN [ROOT-BERNSTEIN85]
8 Java Modeling in Color with UML

Adding color better engages the spatial intelligence of both model-

builders and model-readers alike.

1.2.2 How Many Colors?

We started with four colors. Yet how many colors should we be using?
In visual design, its a good idea to limit the number of colors in a
color scheme. Why? Simply put: its a good way to increase the likelihood
of color harmony within that color scheme.

Two or three colors is usually enough; five is too many. Four-color

combinations must be selected with great care: nothing looks worse
than too many colors, particularly when they lack common elements.
HIDEAKI CHIJIIWA [CHIJIIWA87]

To support visual modeling in color, the last thing we want to do is end

up with something that is visually distracting. We want to support better
design, not distract from it. Hence, no matter how many semantic variations
we might come up with, using four colors seems like a good place to start.

1.2.3 Which Colors?

The three-primary system, first proposed around 1731, defines primary
colors as red, blue, and yellow. It defines secondary colors as orange,
green, and violet.
The perceptual-primary system, first proposed by Leonardo da Vinci,
defines primary colors as red, yellow, blue, and green. These are the per-
ceptual primaries, those colors that do not appear to have any other color
in them.
The six-primary system, first proposed in the 1990s, gives equal
importance to red, yellow, green, blue, orange, and violet. The basis for
this system is that blue and yellow dont make green; instead, bits of green
impurities within so-called blue paint and so-called yellow paint make
green. Hence green (and for that matter orange and violet) deserve to be
considered primary colors too [Wilcox94].
We can mute these colors by adding a little white to them. That makes
text placed on those colors much easier to read. So, for the four archetypes,
we can use pink, pastel yellow, pastel blue, and pastel green. Lets see how!

1.3 THE FOUR ARCHETYPES IN COLOR

Our models always consist of four archetypes: role, moment-interval,
thing, and description.
Lets match up archetypes with colors, to deliver that added impact
were looking for.
Moment-intervals tie together a component model. They express the
heart and soul of what that component is all about. They usually have
parts, called moment-interval details. In a model, moment-intervals often
 Archetypes, Color, and the Domain-Neutral Component 9

encapsulate the most interesting methods. Lets make moment-intervals

pink, the most attention-grabbing of the colors.
Roles played are next when it comes to interesting responsibilities; we
give them the next most attention-grabbing color, yellow. Parties, places,
and things are next; we give them the next color in attention-grabbing,
green. Descriptions usually have fairly simple responsibilities; we give then
the calmest color of the four, blue (see Figure 1-5).
Each of these four colors corresponds to an archetypes characteris-
tics: the attributes, links, methods, plug-in points, and interactions that
corresponding classes more or less follow.
An archetypes characteristics include attributes and links as shown
in Figure 1-6. A blue description knows its type, description, item num-
ber, and default value(s). A green party, place, or thing knows its serial
number, name, address, and custom value(s). A yellow role knows its
assigned number and status. A pink moment-interval knows its number,
date (or date-time or interval), its priority, its total, and its status. A pink
moment-interval detail knows its quantity.
Note the links, from blue to green to yellow to pink. In addition,
usually, a pink moment-interval links to little pink moment-interval
details. And sometimes a pink moment-interval links to planned or actual
pink moment-interval(s).
You can tailor each blue-green-yellow-pink sequence you work with,
customizing according to the level of specificity you need. Heres how.
Include blue if you have groupings of values that apply again and again.
Include green if you must track parties, places, or things individually

<<thing>> <<description>> A catalog-

A party (person or
organization), PartyPlaceThing Description entry-like
place, or thing description

<<role>>
A way of <<moment-interval>> <<mi-detail>>
Role
participating MomentInterval MIDetail
in something

A moment in time or Often, pink

an interval of time that moment-intervals
you need to track or have parts,
do something about called mi-details.

What color is that class?

- Is it a moment or interval? It's pink.
- Is it a role played? It's yellow.
- Is it a catalog-entry-like description? It's blue.
- Otherwise, it's a party, place, or thing. It's green.

FIGURE 1-5. The four archetypes and their colors.

10 Java Modeling in Color with UML

<<thing>> <<description>> Drop a class along

PartyPlaceThing Description the links when you
type don't need the level of
serialNumber 0..* 1
specificity provided by
name description
that class.
address itemNumber

customValue defaultValue

<<moment-interval>>
0..*
MomentInterval
<<role>> <<mi-detail>>
number
Role 1 1..* MIDetail
1 0..* dateOrDateTimeOrInterval
assignedNumber qty
priority
status
total
0..*
status
actual

0..1 plan
Not shown:
- Link attributes
- "Class as collection" attributes

FIGURE 1-6. Archetypesand their attributes and links.

rather than by quantity. Include yellow if you have role-specific respon-

sibilities. Include pink if you need to remember the corresponding
moment in time or interval of time.
An archetypes characteristics include methods (Figure 1-7). A blue
description assesses across its corresponding green parties, places, or
things; finds available; calculates quantity available; calculates total for a
detail (with quantity and unit of measure); and lists its corresponding par-
ties, places, or things. It also has static class-level methods (underlined,
with behavior across all the objects in the class) to list all descriptions and
to assess across all descriptions.
A green party, place, or thing assesses across its corresponding yel-
low roles; gets its custom value or, if not present, asks its corresponding
blue description for its default value and returns it as its own; and lists its
associated roles. Class-level methods list and assess across all parties,
places, or things in the class.
A yellow role assesses across and lists its corresponding pink
moment-intervals. At the class level, it lists all roles and assesses across all
objects in the class.
A pink moment-interval makes one (supports the business process
for making one, that is), adds details (parts), and calculates its total (inter-
acting with its parts to do so). It can also recalculate its total (forcing a
 Archetypes, Color, and the Domain-Neutral Component 11

<<description>>
Drop a class along
<<thing>> Description
the links when you
PartyPlaceThing
assessAcrossPPTs don't need the level of
specificity provided by
assessAcrossRoles findAvailable
that class; adjust method
getCustomElseDefaultValue calcQtyAvailable
names accordingly.
listRoles calcTotalFor
listPPTs listPPTs
assessAcrossPPTs listDescs
assessAcrossDescs

<<moment-interval>>
MomentInterval
<<role>>
makeMomentInterval
Role
addDetail
assessAcrossMIs calcTotal <<mi-detail>>
listMIs recalcTotal MIDetail
listRoles complete
cancel calcTotal
assessAcrossRoles
mi_generateNext
mi_assessWRTPrior
mi_assessWRTNext
The "mi" method-name prefix
mi_comparePlanVsActual indicates a method that interacts
listMIs with pink moment-intervals.
Not shown: assessAcrossMIs
- Getters/setters
- Adders/removers

FIGURE 1-7. Archetypes and their methods.

recalculation, regardless of any internally buffered value). It accepts mes-

sages asking it to complete or cancel the moment-interval. It also provides
behavior across other pink moment-intervals (designated by the prefix
mi_): generate next, assess with respect to prior moment-intervals,
assess with respect to next moment-intervals, and compare plan vs.
actual. It also has two class-level methods: list all and assess across all. And
each pink moment-interval detail calculates its total.
Note that we tend to list method names this way:

1. Makethe business-process method for a pink moment-interval

2. Calculate, assess, and the like
3. List
4. Moment-interval (mi) methods (when a pink interacts with
other pinks)
5. Class (static) methods, ones that apply across all of the objects in
a class (such methods are underlined)

An archetypes characteristics include plug-in points for adapting the

behavior of an archetype (Figure 1-8). A blue description needs a plug-in
point when it has algorithmically complex behavior and we want the option
12 Java Modeling in Color with UML

<<thing>> <<description>>

PartyPlaceThing Description

assessWithPlugInElseDefault

0..1
interface
<<plug-in point>>
IAssess

assess

<<role>> <<moment-interval>> <<mi-detail>>

Role MomentInterval MIDetail

makeMomentInterval

1
interface
<<plug-in point>> For example,
IMakeSale
IMakeMomentInterval

makeMomentInterval

FIGURE 1-8. Archetypes and their plug-in points.

of plugging in an alternative behavior at times (IAssess, for example,

ICalcInterest). A pink moment-interval needs a plug-in point whenever the
business process is complicated enough that we really should design in plug-
in flexibility to accommodate (anticipated or unanticipated) business process
change over time (IMakeMomentInterval, for example, IMakeSale with a
one click or a shopping cart plug-in).
Figure 1-9 summarizes the attributes, links, methods, and plug-in
points of archetypes. We add interactions later in this chapter.

1.4 GIVEN A CLASS, WHATS THE COLOR,

WHATS THE ARCHETYPE?
So given a class, what archetype or color should you use? Use this checklist:

1. Is it a moment in time or an interval of time, something the sys-

tem needs to track for business or for legal reasons? If so, its a
pink moment-interval.
2. Otherwise, is it a role? If so, its a yellow role.
 Archetypes, Color, and the Domain-Neutral Component 13

<<description>>
<<thing>> Description
PartyPlaceThing type
serialNumber description
name itemNumber
address defaultValue
0..* 1
customValue assessWithPlugInElseDefault
assessAcrossRoles assessAcrossPPTs
getCustomElseDefaultValue findAvailable
listRoles calcQtyAvailable interface
listPPTs calcTotalFor <<plug-in point>>
0..1
assessAcrossPPTs listPPTs IAssess
listDescs
1
assessAcrossDescs assess

Drop a class along

<<moment-interval>> the links when you
0..*
MomentInterval don't need the level of
<<role>> specificity provided by
number
Role that class; adjust method
dateOrDateTimeOrInterval
assignedNumber names accordingly.
priority
status 1 0..*
total
assessAcrossMIs
status
listMIs
makeMomentInterval
listRoles <<mi-detail>>
addDetail
assessAcrossRoles 1 1..* MIDetail
calcTotal
qty
recalcTotal
calcTotal
complete
cancel
mi_generateNext
Often, pink
mi_assessWRTPrior moment-intervals
interface
mi_assessWRTNext have parts,
<<plug-in point>>
1
IMakeMomentInterval mi_comparePlanVsActual 0..* called mi-details.
listMIs actual
makeMomentInterval assessAcrossMIs

0..1 plan

FIGURE 1-9. Archetypes and their attributes, links, methods, and plug-in points.

3. Otherwise, is it a catalog-like description, a grouping of values that

you can apply again and again? If so, its a blue description.
4. Otherwise, its a party, place, or thing. Its a green party, place, or
thing (green is the default; if not pink, yellow, or blue, its green).

We also use white occasionally, for notes, for plug-in points, and for
system-interaction proxies.
 <<description>> <<description>>

14
PartyDescription <<place>> PlaceDescription
<<party>>
type Place type
Party

description serialNumber description

serialNumber
itemNumber name itemNumber
name
defaultValue address defaultValue
address
0..* 1 0..* 1
assessWithPlugInElseDefault customValue assessWithPlugInElseDefault
customValue
assessAcrossParties assessAcrossRoles assessAcrossPlaces
assessAcrossRoles
Interacts with its findAvailable getCustomElseDefaultValue findAvailable
getCustomElseDefaultValue
yellow roles or its calcQtyAvailable listRoles calcQtyAvailable
listRoles
pink moment-intervals calcTotalFor calcTotalFor
listParties listPlaces
listParties assessAcrossPlaces listPlaces
assessAcrossParties
listDescs listDescs
1 1
Interacts with its assessAcrossDescs assessAcrossDescs
green parties or
its pink moment-
0..1
intervals 0..1
0..1 0..1
interface
interface
<<role>> <<role>>
<<plug-in point>>
PartyRole <<plug-in point>>
IAssess PlaceRole
Interacts IAssess
with its pink assignedNumber assignedNumber
status assess status
moment-intervals assess
assessAcrossMIs assessAcrossMIs
<<moment-interval>>
listMIs 1 0..* MomentInterval 0..* 1 listMIs
listRoles listRoles
number
assessAcrossRoles assessAcrossRoles
dateOrDateTimeOrInterval
priority
total
status
makeMomentInterval
<<moment-interval>> 1 0..* <<moment-interval>>
1 0..* addDetail
PriorMI NextMI
calcTotal
assess
recalcTotal
complete
cancel
Interacts mi_generateNext <<description>>
- With its pink mi-details mi_assessWRTPrior ThingDescription
- With its pink prior moment-intervals mi_assessWRTNext <<thing>>
type
- With its pink next moment-intervals Thing
mi_comparePlanVsActual 0..*
- With its coresponding yellow roles, description
listMIs actual serialNumber
green party/place/things, or itemNumber
assessAcrossMIs name
blue descriptions defaultValue
address
1 0..1 plan 0..* 1 assessWithPlugInElseDefault
customValue
assessAcrossThings
1 assessAcrossRoles
findAvailable
interface getCustomElseDefaultValue
calcQtyAvailable
<<plug-in point>> listRoles
calcTotalFor
IMakeMomentInterval listThings
listThings
assessAcrossThings
listDescs
makeMomentInterval
1 assessAcrossDescs

0..1
0..1 interface
<<role>> <<plug-in point>>
1..*
ThingRole IAssess
<<mi-detail>>
assignedNumber
0..* 0..*
MomentIntervalDetail assess
status
qty
assessAcrossMIs
calcTotal
listMIs
listRoles
assessAcrossRoles

FIGURE 1-10. The domain-neutral component.

 Archetypes, Color, and the Domain-Neutral Component 15

1.5 THE DOMAIN-NEUTRAL COMPONENT

Archetypes in color are very useful little building blocks.
Lets take them a step further.
These four archetypes in color plug into each other in a very repeat-
able and predictable way. We call it a domain-neutral component.
Weve built hundreds and hundreds of models. All of them follow
this domain-neutral component model. In Chapters 25, youll find 61
domain-specific components. All of them follow the domain-neutral com-
ponent shown in Figure 1-10.

1.6 INTERACTIONS WITHIN THE

DOMAIN-NEUTRAL COMPONENT
This section focuses on archetype interactions within the domain-neutral
component.
Some refer to class diagrams as static and sequence diagrams as
dynamic. Actually, neither diagram moves! It takes some imagination,
some additional internal visualization, to see the motion.
Class diagrams are implicitly dynamic. (It takes a bit of imagination
to see the interactions, although one really can learn to see them!)
Sequence diagrams are explicitly dynamic (well, as good as it gets without
having on-screen simulations in front of you).
Archetypes include typical interactions too. Once you know those
interactions, even class diagrams spring to life.
Now rest assured, this is not an excuse for not including sequence
diagrams in this book! Actually, you will find an equal balance of
sequence diagrams and class diagrams in here.
We feel compelled to make this added point though, that with arche-
type interactions you really can learn to look at a class diagram and visu-
alize its most important interactions.
So lets look at how to do this. First, well visualize an association in
three-dimensions. Then, well visualize message-sends within that new
dimension. And finally, well walk through a series of class diagram and
sequence diagram pairs, so you can begin to visualize those interactions
for yourself.
Here we go.
Consider an association with a 0..* marking on one end (Figure 1-11).
Already, the class diagram is asking us to visualize beyond what it
explicitly represents. An object on the left side links to some number of
objects on the right side. Visually, you can translate it to something like
Figure 1-12.
Again, the class diagram is asking us to see beyond what is explicitly
represented. The object on the left interacts with the objects on the right,
16 Java Modeling in Color with UML

0..*
association

FIGURE 1-11. An association link.

how to visualize it:

spatially

FIGURE 1-12. How to visualize that link, spatially.

calc
how to visualize it: calc calc
calc
dynamically calc
assess
calc
FIGURE 1-13. How to visualize that link, dynamically.

by sending messages to each one. Figure 1-13 shows how to visualize the
implicit dynamics of an association link.
Thankfully, sequence diagrams are explicitly dynamic, giving added
visual clues about the sequence of interactions and message sends inher-
ent within a class diagram.
Here are the archetypal interactions for the domain-neutral compo-
nentand indeed the archetypal interactions for all components in this
book (Figures 1-14 to 1-19).
 <<description>>
<<description>>
<<party>> PartyDescription <<place>>
PlaceDescription
Party Place
type
type
serialNumber description serialNumber
description
name itemNumber name
itemNumber
address defaultValue address
defaultValue
customValue 0..* 1 assessWithPlugInElseDefault customValue 0..* 1
assessWithPlugInElseDefault
assess assessAcrossParties assess
assessAcrossPlaces
assessAcrossRoles findAvailable assessAcrossRoles
findAvailable
getCustomElseDefaultValue calcQtyAvailable getCustomElseDefaultValue
Interacts with its calcQtyAvailable
listRoles calcTotalFor listRoles
yellow roles or its calcTotalFor
listParties listParties listPlaces
pink moment-intervals listPlaces
assessAcrossParties listDescs assessAcrossPlaces
listDescs
1 assessAcrossDescs
1 assessAcrossDescs
Interacts with its
green parties or
its pink moment- 0..1
intervals
interface 0..1 0..1
0..1
<<plug-in point>>
<<role>> interface
<<role>> IAssess
PlaceRole <<plug-in point>>
Interacts PartyRole
with its pink assess assignedNumber IAssess
assignedNumber
moment-intervals status
status assess
<<moment-interval>> assessAcrossMIs
assessAcrossMIs
MomentInterval 0..* 1 listMIs
listMIs 1 0..*
listRoles
listRoles number
assessAcrossRoles
assessAcrossRoles dateOrDateTimeOrInterval
priority
total
status
makeMomentInterval
<<moment-interval>> 1 0..* <<moment-interval>>
1 0..* addDetail
PriorMI NextMI
calcTotal
assess
recalcTotal
complete
cancel
<<description>>
Interacts mi_generateNext
<<thing>> ThingDescription
- With its pink mi-details mi_assessWRTPrior
Thing type
- With its pink prior moment-intervals mi_assessWRTNext
- With its pink next moment-intervals serialNumber description
mi_comparePlanVsActual 0..*
- With its coresponding yellow roles, name itemNumber
listMIs actual
green party/place/things, or address defaultValue
assessAcrossMIs
blue descriptions assessWithPlugInElseDefault
customValue 0..* 1
1 0..1 plan assessAcrossThings
assess
assessAcrossRoles findAvailable

getCustomElseDefaultValue calcQtyAvailable
1
listRoles calcTotalFor
interface
listThings listThings
<<plug-in point>>
assessAcrossThings listDescs
IMakeMomentInterval
assessAcrossDescs
1
makeMomentInterval

0..1 0..1
<<role>> interface
1..*
ThingRole <<plug-in point>>
<<mi-detail>> IAssess
assignedNumber
0..* 0..*
MomentIntervalDetail
status
qty assess
assessAcrossMIs
calcTotal
listMIs
listRoles
assessAcrossRoles

FIGURE 1-14A. Assess value to business: implicit dynamics.

aSender aRole aMomentInterval aMomentIntervalDetail aThingRoleDescription

...PartyRole ...MomentInterval ...MomentIntervalDetail ...ThingDescription

In this sequence,
1: assessAcrossMIs a pink mi-detail
interacts directly
FOR each with a blue description
2: calcTotal
moment-interval (implying a direct rather
than indirect link between
the two in a corresponding
FOR each
3: calcTotal class diagram).
moment-interval
4: calcTotalFor
detail

calcTotalFor
(aDetail)

5: 'getQty' Let the one who

needs the values
6: 'getUOM'
ask for them.

FIGURE 1-14B. Assess value to business: explicit dynamics. 17

18 Java Modeling in Color with UML

<<description>>
<<description>>
<<party>> PartyDescription <<place>>
PlaceDescription
Party Place
type
type
serialNumber description serialNumber
description
name itemNumber name
itemNumber
address defaultValue address
defaultValue
customValue 0..* 1 assessWithPlugInElseDefault customValue 0..* 1
assessWithPlugInElseDefault
assess assessAcrossParties assess
assessAcrossPlaces
assessAcrossRoles findAvailable assessAcrossRoles
findAvailable
getCustomElseDefaultValue calcQtyAvailable getCustomElseDefaultValue
Interacts with its calcQtyAvailable
listRoles calcTotalFor listRoles
yellow roles or its calcTotalFor
listParties listParties listPlaces
pink moment-intervals listPlaces
assessAcrossParties listDescs assessAcrossPlaces
listDescs
1 assessAcrossDescs
1 assessAcrossDescs
Interacts with its
green parties or
its pink moment- 0..1
intervals
interface 0..1 0..1
0..1
<<plug-in point>>
<<role>> interface
<<role>> IAssess
PlaceRole <<plug-in point>>
Interacts PartyRole
with its pink assess assignedNumber IAssess
assignedNumber
moment-intervals status
status assess
<<moment-interval>> assessAcrossMIs
assessAcrossMIs
MomentInterval 0..* 1 listMIs
listMIs 1 0..*
listRoles
listRoles number
assessAcrossRoles
assessAcrossRoles dateOrDateTimeOrInterval
priority
total
status
makeMomentInterval
<<moment-interval>> 1 0..* <<moment-interval>>
1 0..* addDetail
PriorMI NextMI
calcTotal
assess
recalcTotal
complete
cancel
<<description>>
Interacts mi_generateNext
<<thing>> ThingDescription
- With its pink mi-details mi_assessWRTPrior
Thing type
- With its pink prior moment-intervals mi_assessWRTNext
- With its pink next moment-intervals serialNumber description
mi_comparePlanVsActual 0..*
- With its coresponding yellow roles, name itemNumber
listMIs actual
green party/place/things, or address defaultValue
assessAcrossMIs
blue descriptions assessWithPlugInElseDefault
customValue 0..* 1
1 0..1 plan assessAcrossThings
assess
assessAcrossRoles findAvailable

getCustomElseDefaultValue calcQtyAvailable
1
listRoles calcTotalFor
interface
listThings listThings
<<plug-in point>>
assessAcrossThings listDescs
IMakeMomentInterval
assessAcrossDescs
1
makeMomentInterval

0..1 0..1
<<role>> interface
1..*
ThingRole <<plug-in point>>
<<mi-detail>> IAssess
assignedNumber
0..* 0..*
MomentIntervalDetail
status
qty assess
assessAcrossMIs
calcTotal
listMIs
listRoles
assessAcrossRoles

FIGURE 1-15A. Make moment-interval: implicit dynamics.

aSender aMomentInterval aSequencer

...MomentInterval ...IMakeMomentInterval

1: makeMomentInterval

Include the moment-interval

2: makeMomentInterval itself as an argument:
makeMomentInterval(aMomentInterval)

Convention: a message name in single

quotes is a comment; corresponding
3: 'stepByStep...'
class diagram(s) won't include a
corresponding method for it. Most
common use: getters and setters.

FIGURE 1-15B. Make moment-interval: explicit dynamics.

 Archetypes, Color, and the Domain-Neutral Component 19

<<description>>
<<description>>
<<party>> PartyDescription <<place>>
PlaceDescription
Party Place
type
type
serialNumber description serialNumber
description
name itemNumber name
itemNumber
address defaultValue address
defaultValue
customValue 0..* 1 assessWithPlugInElseDefault customValue 0..* 1
assessWithPlugInElseDefault
assess assessAcrossParties assess
assessAcrossPlaces
assessAcrossRoles findAvailable assessAcrossRoles
findAvailable
getCustomElseDefaultValue calcQtyAvailable getCustomElseDefaultValue
Interacts with its calcQtyAvailable
listRoles calcTotalFor listRoles
yellow roles or its calcTotalFor
listParties listParties listPlaces
pink moment-intervals listPlaces
assessAcrossParties listDescs assessAcrossPlaces
listDescs
1 assessAcrossDescs
1 assessAcrossDescs
Interacts with its
green parties or
its pink moment- 0..1
intervals
interface 0..1 0..1
0..1
<<plug-in point>>
<<role>> interface
<<role>> IAssess
PlaceRole <<plug-in point>>
Interacts PartyRole
with its pink assess assignedNumber IAssess
assignedNumber
moment-intervals status
status assess
<<moment-interval>> assessAcrossMIs
assessAcrossMIs
MomentInterval 0..* 1 listMIs
listMIs 1 0..*
listRoles
listRoles number
assessAcrossRoles
assessAcrossRoles dateOrDateTimeOrInterval
priority
total
status
makeMomentInterval
<<moment-interval>> 1 0..* <<moment-interval>>
1 0..* addDetail
PriorMI NextMI
calcTotal
assess
recalcTotal
complete
cancel
<<description>>
Interacts mi_generateNext
<<thing>> ThingDescription
- With its pink mi-details mi_assessWRTPrior
Thing type
- With its pink prior moment-intervals mi_assessWRTNext
- With its pink next moment-intervals serialNumber description
mi_comparePlanVsActual 0..*
- With its coresponding yellow roles, name itemNumber
listMIs actual
green party/place/things, or address defaultValue
assessAcrossMIs
blue descriptions assessWithPlugInElseDefault
customValue 0..* 1
1 0..1 plan assessAcrossThings
assess
assessAcrossRoles findAvailable

getCustomElseDefaultValue calcQtyAvailable
1
listRoles calcTotalFor
interface
listThings listThings
<<plug-in point>>
assessAcrossThings listDescs
IMakeMomentInterval
assessAcrossDescs
1
makeMomentInterval

0..1 0..1
<<role>> interface
1..*
ThingRole <<plug-in point>>
<<mi-detail>> IAssess
assignedNumber
0..* 0..*
MomentIntervalDetail
status
qty assess
assessAcrossMIs
calcTotal
listMIs
listRoles
assessAcrossRoles

FIGURE 1-16A. Assess with respect to a subsequent moment-interval: implicit dynamics.

aSender aMomentInterval aNextMomentInterval

...MomentInterval ...NextMI

1: mi_assessWRTNext

FOR each
2: assess
subsequent
moment-interval

FIGURE 1-16B. Assess with respect to a subsequent moment-interval: explicit dynamics.

20 Java Modeling in Color with UML

<<description>>
<<description>>
<<party>> PartyDescription <<place>>
PlaceDescription
Party Place
type
type
serialNumber description serialNumber
description
name itemNumber name
itemNumber
address defaultValue address
defaultValue
customValue 0..* 1 assessWithPlugInElseDefault customValue 0..* 1
assessWithPlugInElseDefault
assess assessAcrossParties assess
assessAcrossPlaces
assessAcrossRoles findAvailable assessAcrossRoles
findAvailable
getCustomElseDefaultValue calcQtyAvailable getCustomElseDefaultValue
Interacts with its calcQtyAvailable
listRoles calcTotalFor listRoles
yellow roles or its calcTotalFor
listParties listParties listPlaces
pink moment-intervals listPlaces
assessAcrossParties listDescs assessAcrossPlaces
listDescs
1 assessAcrossDescs
1 assessAcrossDescs
Interacts with its
green parties or
its pink moment- 0..1
intervals
interface 0..1 0..1
0..1
<<plug-in point>>
<<role>> interface
<<role>> IAssess
PlaceRole <<plug-in point>>
Interacts PartyRole
with its pink assess assignedNumber IAssess
assignedNumber
moment-intervals status
status assess
<<moment-interval>> assessAcrossMIs
assessAcrossMIs
MomentInterval 0..* 1 listMIs
listMIs 1 0..*
listRoles
listRoles number
assessAcrossRoles
assessAcrossRoles dateOrDateTimeOrInterval
priority
total
status
makeMomentInterval
<<moment-interval>> 1 0..* <<moment-interval>>
1 0..* addDetail
PriorMI NextMI
calcTotal
assess
recalcTotal
complete
cancel
<<description>>
Interacts mi_generateNext
<<thing>> ThingDescription
- With its pink mi-details mi_assessWRTPrior
Thing type
- With its pink prior moment-intervals mi_assessWRTNext
- With its pink next moment-intervals serialNumber description
mi_comparePlanVsActual 0..*
- With its coresponding yellow roles, name itemNumber
listMIs actual
green party/place/things, or address defaultValue
assessAcrossMIs
blue descriptions assessWithPlugInElseDefault
customValue 0..* 1
1 0..1 plan assessAcrossThings
assess
assessAcrossRoles findAvailable

getCustomElseDefaultValue calcQtyAvailable
1
listRoles calcTotalFor
interface
listThings listThings
<<plug-in point>>
assessAcrossThings listDescs
IMakeMomentInterval
assessAcrossDescs
1
makeMomentInterval

0..1 0..1
<<role>> interface
1..*
ThingRole <<plug-in point>>
<<mi-detail>> IAssess
assignedNumber
0..* 0..*
MomentIntervalDetail
status
qty assess
assessAcrossMIs
calcTotal
listMIs
listRoles
assessAcrossRoles

FIGURE 1-17A. Get custom else default: implicit dynamics.

aSender aThing aDescription

...Thing ...ThingDescription

1: getCustomElseDefaultValue

IF it has a
2: 'getCustomValue'
custom value,
use it

OTHERWISE
3: 'getDefaultValue'
use the default
value instead

FIGURE 1-17B. Get custom else default: explicit dynamics.

 Archetypes, Color, and the Domain-Neutral Component 21

<<description>>
<<description>>
<<party>> PartyDescription <<place>>
PlaceDescription
Party Place
type
type
serialNumber description serialNumber
description
name itemNumber name
itemNumber
address defaultValue address
defaultValue
customValue 0..* 1 assessWithPlugInElseDefault customValue 0..* 1
assessWithPlugInElseDefault
assess assessAcrossParties assess
assessAcrossPlaces
assessAcrossRoles findAvailable assessAcrossRoles
findAvailable
getCustomElseDefaultValue calcQtyAvailable getCustomElseDefaultValue
Interacts with its calcQtyAvailable
listRoles calcTotalFor listRoles
yellow roles or its calcTotalFor
listParties listParties listPlaces
pink moment-intervals listPlaces
assessAcrossParties listDescs assessAcrossPlaces
listDescs
1 assessAcrossDescs
1 assessAcrossDescs
Interacts with its
green parties or
its pink moment- 0..1
intervals
interface 0..1 0..1
0..1
<<plug-in point>>
<<role>> interface
<<role>> IAssess
PlaceRole <<plug-in point>>
Interacts PartyRole
with its pink assess assignedNumber IAssess
assignedNumber
moment-intervals status
status assess
<<moment-interval>> assessAcrossMIs
assessAcrossMIs
MomentInterval 0..* 1 listMIs
listMIs 1 0..*
listRoles
listRoles number
assessAcrossRoles
assessAcrossRoles dateOrDateTimeOrInterval
priority
total
status
makeMomentInterval
<<moment-interval>> 1 0..* <<moment-interval>>
1 0..* addDetail
PriorMI NextMI
calcTotal
assess
recalcTotal
complete
cancel
<<description>>
Interacts mi_generateNext
<<thing>> ThingDescription
- With its pink mi-details mi_assessWRTPrior
Thing type
- With its pink prior moment-intervals mi_assessWRTNext
- With its pink next moment-intervals serialNumber description
mi_comparePlanVsActual 0..*
- With its coresponding yellow roles, name itemNumber
listMIs actual
green party/place/things, or address defaultValue
assessAcrossMIs
blue descriptions assessWithPlugInElseDefault
customValue 0..* 1
1 0..1 plan assessAcrossThings
assess
assessAcrossRoles findAvailable

getCustomElseDefaultValue calcQtyAvailable
1
listRoles calcTotalFor
interface
listThings listThings
<<plug-in point>>
assessAcrossThings listDescs
IMakeMomentInterval
assessAcrossDescs
1
makeMomentInterval

0..1 0..1
<<role>> interface
1..*
ThingRole <<plug-in point>>
<<mi-detail>> IAssess
assignedNumber
0..* 0..*
MomentIntervalDetail
status
qty assess
assessAcrossMIs
calcTotal
listMIs
listRoles
assessAcrossRoles

FIGURE 1-18A. Find available: implicit dynamics.

aSender aDescription aThing aRole

...ThingDescription ...Thing ...ThingRole

1: findAvailable

FOR each
2: assess
thing

FOR each
3: assessAcrossMIs
role

FIGURE 1-18B. Find available: explicit dynamics.

22 Java Modeling in Color with UML

<<description>>
<<description>>
<<party>> PartyDescription <<place>>
PlaceDescription
Party Place
type
type
serialNumber description serialNumber
description
name itemNumber name
itemNumber
address defaultValue address
defaultValue
customValue 0..* 1 assessWithPlugInElseDefault customValue 0..* 1
assessWithPlugInElseDefault
assess assessAcrossParties assess
assessAcrossPlaces
assessAcrossRoles findAvailable assessAcrossRoles
findAvailable
getCustomElseDefaultValue calcQtyAvailable getCustomElseDefaultValue
Interacts with its calcQtyAvailable
listRoles calcTotalFor listRoles
yellow roles or its calcTotalFor
listParties listParties listPlaces
pink moment-intervals listPlaces
assessAcrossParties listDescs assessAcrossPlaces
listDescs
1 assessAcrossDescs
1 assessAcrossDescs
Interacts with its
green parties or
its pink moment- 0..1
intervals
interface 0..1 0..1
0..1
<<plug-in point>>
<<role>> interface
<<role>> IAssess
PlaceRole <<plug-in point>>
Interacts PartyRole
with its pink assess assignedNumber IAssess
assignedNumber
moment-intervals status
status assess
<<moment-interval>> assessAcrossMIs
assessAcrossMIs
MomentInterval 0..* 1 listMIs
listMIs 1 0..*
listRoles
listRoles number
assessAcrossRoles
assessAcrossRoles dateOrDateTimeOrInterval
priority
total
status
makeMomentInterval
<<moment-interval>> 1 0..* <<moment-interval>>
1 0..* addDetail
PriorMI NextMI
calcTotal
assess
recalcTotal
complete
cancel
<<description>>
Interacts mi_generateNext
<<thing>> ThingDescription
- With its pink mi-details mi_assessWRTPrior
Thing type
- With its pink prior moment-intervals mi_assessWRTNext
- With its pink next moment-intervals serialNumber description
mi_comparePlanVsActual 0..*
- With its coresponding yellow roles, name itemNumber
listMIs actual
green party/place/things, or address defaultValue
assessAcrossMIs
blue descriptions assessWithPlugInElseDefault
customValue 0..* 1
1 0..1 plan assessAcrossThings
assess
assessAcrossRoles findAvailable

getCustomElseDefaultValue calcQtyAvailable
1
listRoles calcTotalFor
interface
listThings listThings
<<plug-in point>>
assessAcrossThings listDescs
IMakeMomentInterval
assessAcrossDescs
1
makeMomentInterval

0..1 0..1
<<role>> interface
1..*
ThingRole <<plug-in point>>
<<mi-detail>> IAssess
assignedNumber
0..* 0..*
MomentIntervalDetail
status
qty assess
assessAcrossMIs
calcTotal
listMIs
listRoles
assessAcrossRoles

FIGURE 1-19A. Invoke plug-in else default: implicit dynamics.

aSender aThing aDescription anIAssess

...Thing ...ThingDescription ...IAssess3

1: assess assessWithPlugInElseDefault
2: assessWithPlugInElseDefault (aThing)

IF there is
3: assess assess
a plug-in,
use it (aThing)

4: 'gets,sets'

5: 'defaultAlgorithm'
ELSE
use the default
algorithm

FIGURE 1-19B. Invoke plug-in else default: explicit dynamics.

 Archetypes, Color, and the Domain-Neutral Component 23

1.7 COMPONENT CONNECTIVITY

On printed circuit boards, some components directly connect (that is to
say, they are hardwired). Other components plug in. Why not make every
element something you can plug in? Sockets everywhere! Well, the rea-
son is that its simply not cost-effective to do so with printed circuit board
design.
The same is true with software components. Some are hardwired,
some are plug-in. Although we could have plug-in points everywhere, its
not cost-effective to do so. So we choose and design in plug-in points at
those places where we needand can afford to implementadded flexi-
bility.
The rest of this section moves into a deeper level of detail regarding
component connectivity. If you are new to these component concepts,
you might wish to skip this for now and come back to it at another time.
Yet for those with inquiring minds that want to know, here are the details
behind component connectivity.
A direct connect links an object in one component with objects
in another component (Figure 1-20).
A product-sale object holds a collection of some number of ship-
ments. And a shipment holds a collection of some number of product
sales.
We can ask a product sale to assess the timeliness of its shipments;
it interacts directly with its shipment objects (Figure 1-21).
And we can ask a shipment if it was shipped before the due dates for
its corresponding product sales; it interacts directly with its product-sale
objects (Figure 1-22).

Hardwired component connections:

each component direct-connects,
specifying the classes of objects it
connects to.

ProductSale Shipment

ProductSale Shipment

<<moment-interval>> <<moment-interval>>
ProductSale 0..* 0..* Shipment

assessTimelinessOfShipments assessTimeliness
doesDateMeetDueDate wasShippedBeforeDueDate

FIGURE 1-20. Direct connectivity.

24 Java Modeling in Color with UML

aSender aProductSale aShipment

...ProductSale ...Shipment

1: assessTimelinessOfShipments

FOR each
2: assessTimeliness
shipment

FIGURE 1-21. Direct connectivity: A product

sale interacts with its shipments.

aSender aShipment aProductSale

...Shipment ...ProductSale

1: wasShippedBeforeDueDate

FOR each
2: doesDateMeetDueDate
product
sale

FIGURE 1-22. Direct connectivity: A shipment

interacts with its product sales.
 Archetypes, Color, and the Domain-Neutral Component 25

Plug-in component connections:

each component has plug-in points,
eliminating needing to know the class(es)
of objects it might connect to.

ProductSale Shipment
ProductSale Shipment
IProductSale IShipment

interface <<moment-interval>>
<<plug-in point>> Shipment
0..*
IProductSale
assessTimeliness
doesDateMeetDueDate wasShippedBeforeDueDate

<<moment-interval>> interface
ProductSale <<plug-in point>>
0..*
IShipment
assessTimelinessOfIShipments
doesDateMeetDueDate assessTimeliness

FIGURE 1-23. Plug-in connectivity.

Now consider plug-in connectivity. An object interacts with what-

ever is plugged into a plug-in point (Figure 1-23).
A product sale holds a collection of objects from classes that imple-
ment the IShipment interface. A shipment holds a collection of objects
from classes that implement the IProductSale interface. It really does not
matter which classes the connecting objects are in, only that the inter-
face must be implemented.
We can ask a product sale to assess the timeliness of its shipments;
it interacts with its IShipment implementers, whatever is plugged into
that plug-in point (Figure 1-24).
And we can ask a shipment if it was shipped before the due dates for
its corresponding product sales; it interacts with its IProductSale imple-
menters, whatever is plugged into that plug-in point (Figure 1-25).
For modeling simplicity, we build models with direct connections.
Then we choose where we want flexibility and add plug-in connectivity
(like deciding where we want sockets on a circuit board; its a decision in
adding flexibility).

1.8 TWELVE COMPOUND COMPONENTS

What if you had a substantial collection of enterprise-component mod-
els? Each component would establish a fundamental model shape, the
most common responsibilities for the classes and interfaces, and the plug-
in points for extending capabilities. Each component would give your
modeling team something more than a blank whiteboard for getting
started in building a model for your application or family of applications.
26 Java Modeling in Color with UML

aSender aShipment anIProductSale

...Shipment ...IProductSale

1: wasShippedBeforeDueDate

FOR each
2: doesDateMeetDueDate
IProductSale
implementer

FIGURE 1-24. Plug-in connectivity: A product

sale and its shipments.

aSender aProductSale anIShipment

...ProductSale ...IShipment

1: assessTimelinessOfShipments

FOR each
2: assessTimeliness
IShipment
implementer

FIGURE 1-25. Plug-in connectivity: A shipment

and its product sales.
 Archetypes, Color, and the Domain-Neutral Component 27

This book delivers a collection of 61 enterprise components.

These components are ready to use and reuse as you see fit. You can
put them to work in a number of ways, for example:

Use as-is.
Extend a component by plugging in new capabilities at the plug-

in points.
Extend by adding additional content.

Use as a cross-check, an outside opinion, one that you can com-

pare and contrast with your own ongoing work.

The twelve compound components are shown in Figure 1-26.

Make or Buy... Sell... Relate... Coordinate

and Support...

MaterialResourceMgmt ProductSaleMgmt HumanResourceMgmt ProjectActivityMgmt

FacilityMgmt CashSaleMgmt RelationshipMgmt AccountingMgmt

ManufacturingMgmt CustomerAccountMgmt DocumentMgmt

InventoryMgmt

FIGURE 1-26. The twelve compound components.

28 Java Modeling in Color with UML

1.9 SUGGESTED READING PATHS

You might choose to read this book in any number of ways.
If you are interested in a sampling of interesting compound components,
read the first major section of each chapter (that is to say, 2.1, 3.1, 4.1,
and 5.1).
If you are interested in a top-down understanding of the components,
begin with project-activity management and then move to its subordi-
nates: material-resource management, facility management, manufac-
turing management, inventory management, and human-resource
management. Then scan the others.
If you are interested in learning specific modeling tips, begin by scan-
ning the modeling-tips appendix. Then carefully study Chapter 2. Finally,
scan Chapters 35 for additional tips. (We present each tip right after
weve shown its application by example. Once we present a tip, we do not
repeat it in subsequent material. So Chapter 2 has the most tips.)
If you are interested in the domain-neutral component and its steady
application across 61 components, copy the domain-neutral component
with four colors of Post-it Notes and then study the class-diagram shapes
in Chapters 25, looking at whats the same and whats different, observ-
ing the little things along the way.
If you are interested in templates, plans, and plan executions, study the
sections on manufacturing management and then activity management.
If you are interested in material resources that eventually become
products and how the two interrelate and interact, read the sections on
material-resource management, then product-sale management, and then
inventory management.
If you are interested in system and device interaction, read the sections
on manufacturing management (especially the section on device interac-
tion) and accounting management (the part within accounting payment,
dealing with authorization-system interaction).
If you are interested in the development process, read Chapter 1, scan
Chapters 15, and then study Chapter 6.

1.10 SUMMARY
This chapter introduced enterprise-component modeling using color.
In practice, we have developed enterprise-model components and a
process for building, applying, and adapting those components. Along
the way, weve discovered that encoding added layers of information
(roles, moment-intervals, things, and descriptions) was an essential ingre-
dient for both building and reading component models; we found that
color was especially suitable for adding these layers of information.
Component modeling with color is so effective that we expect that
we will never again return to the monotonous flatland of monochrome
modeling.
So get a set of four-color Post-it Notes and try this out for yourself.
Take an existing model you are working onor start with a new one, if
you wish. Add stickers for the pink moment-intervals; the yellow roles;
 Archetypes, Color, and the Domain-Neutral Component 29

the green parties, places, or things; and blue descriptions. Then stand back
and check it out. Discuss it with a colleague. Walk through it with a
domain expert.
Or, if you already have a large model, get a set of color highlighting
pens (pink, yellow, green, and blue) and highlight the class names in your
model. This is another good way to get started.

REFERENCES
Color and Visualization
[Chijiiwa87] Chijiiwa, Hideaki, Color Harmony. Cincinnati: Rockport
Publishers, 1987.
[Gardner83] Gardner, Howard, Frames of Mind: The Theory of Multiple
Intelligences. New York: Basic Books, 1983.
The Elements of Color. New York: Van Nostrand Reinhold, 1970.
[Root-Bernstein85] Root-Bernstein, Robert Scott, Visual Thinking: The Art of
Imagining Reality. Transactions of the American Philosophical Society,
Volume 75, 1985.
[Tufte90] Tufte, Edward R., Envisioning Information. Cheshire, CT: Graphics
Press, 1990.
Walker, Morton, The Power of Color. Garden City Park, NY: Avery, 1991.
[Wilcox94] Wilcox, Michael, Blue and Yellow Dont Make Green, Revised
Edition. Cincinnati: North Light Books, 1994.

Modeling
Booch, Grady, with James Rumbaugh and Ivar Jacobson, UML User Guide.
Reading, MA: Addison Wesley, 1999.
[Coad97a] Coad, Peter, Boundary; Colors; Timeline; Status. The Coad
Letter. Object International (www.oi.com), September 30, 1997.
[Coad97b] Coad, Peter, How to Build Better Object Models. Tutorial.
OOPSLA, Atlanta, October 1997.
[Coad92] Coad, Peter, and Mayfield, Mark, Object-Oriented Patterns.
Communications of the ACM. September 1992.
[Coad95-97] Coad, Peter with Mark Mayfield and David North, Object
Models: Strategies, Patterns, and Applications. Second Edition. Upper
Saddle River, NJ: Prentice Hall, 1997.
Curran, Thomas, and Gerhard Keller with Andrew Ladd, SAP R/3 Business
Blueprint. Upper Saddle River, NJ: Prentice Hall, 1998.
Fowler, Martin, Analysis Patterns. Reading, MA: Addison Wesley, 1996.
Fowler, Martin, with Kendall Scott, UML Distilled. Reading, MA: Addison
Wesley, 1997.
Gamma, Erich, Richard Helm, Ralph Johnson, and John Vlissides, Design
Patterns. Reading, MA: Addison Wesley, 1995.
[Hayakawa68] Hayakawa, S.I., Editor, Use the Right Word. Now published
under the title Choose the Right Word. Pleasantville, NY: Readers
Digest, 1968.
[Webster78] Websters New Twentieth Century Dictionary. New York: Collins
World, 1978.