Understanding Objects by Mark Lewis

Understanding ObjectsUnderstanding Objects
Object Oriented Design for Content Specialists
© Mark Lewis
mlewis@ditametrics.com
Part of the
Alignment blog series.
Download the audio
Recording: mp3 & wav

What & WhyWhat & Why
 For Software Development
– facilitates re-use of code
– single point of maintenance
– data hiding or encapsulation
– API = Application Programming Interface
 For Technical Writing
– facilitates re-use of content
– CMS = Content Management System
– AuthorIT
– XML

Take-AwaysTake-Aways
OO defined for Tech Writers
Examples
Book Recommendations
Ability to speak and do OO

AgendaAgenda
Definitions & Concepts
Simple Objects
Composite Objects
Behaviors / Methods
Responsibilities / Encapsulation
Inheritance
Content Management & Re-use

Definitions & ConceptsDefinitions & Concepts
Object
What it is , What it does and How it interacts with
other objects
…share a common structure and a common behavior
…has a predictable or fixed relationship with other
objects

Class
The definition or blueprint of an Object. Almost
interchangeable with “Object”.
Attribute
A characteristic of an object. What it is…
…programming lingo…
Also known as a Property.
Behavior
An activity of an object. What it does/is responsible
for…
Also known as a Method.

Object
A categorization or classification of things
that allows us to organize functionality or
information in a way that it may be re-
used / re-purposed.

The StrategyThe Strategy
Find the commonality in the “what it is” and
“what it does”
Find the commonality in the attributes and
behaviors
What is shared?
! The design will depend on your GOALS

ComplexComplex
Cell, Organ, System

Common AttributesCommon Attributes
Muscle Cell
– Membrane
– Nucleus
– Endoplasmic Reticulum (protein factory)
– Cytoplasm (fluid medium)
– Mitochondria (energy converters)

Blood Cell
– Membrane
– Nucleus

Nerve Cell
– Membrane
– Nucleus

Simple ObjectSimple Object
cCell “class definition”
– Membrane
– Nucleus
! Attributes common to all cells

Employee
– Address Line 1
– Address Line 2
– City
– State
– Zip
– Other Employee specific attributes:
 Name, SSN, Gender, Full/Part Time, etc.

Company
– Address Line 1
– Address Line 2
– City
– State
– Zip
– Other Company specific attributes:
 Name, Corp. Type, EIN, etc.

Vendor
– Address Line 1
– Address Line 2
– City
– State
– Zip
– Other Vendor specific attributes:
 Name, Vendor Type, Govt. Work, etc.

Simple ObjectsSimple Objects
 cAddress “class definition”
– Address Line 1
– Address Line 2
– City
– State
– Zip
! Classification or categorization of common
attributes / characteristics

Composite ObjectsComposite Objects
 Employee
– cAddress {Addr 1, Addr 2 ….}
– Employee specific attributes
 Company
– Company specific attributes
 Vendor
– Vendor specific attributes
! Re-use of an object

Company
– Mailing Address
– Billing Address
– Shipping Address
– Company specific attributes
! Re-use of an object

Ease of MaintenanceEase of Maintenance
 cAddress/cContact (* = new)
– Address Line 1
– Address Line 2
– City
– State
– Zip
– Voice Phone Number*
– Fax Phone Number*
– Email*
! Maintenance is reduced to one place

BehaviorsBehaviors
 cCell “class definition”
– Grow
– Reproduce
– Intake Nutrients
– Output Waste
– Send Message
! Behaviors are what an object does & what it is
responsible for
! Behaviors common to all cells

BehaviorsBehaviors
 Muscle
– Contract
– Relax
 Blood
– Absorb Oxygen
– Release Oxygen
 Nerve
– Interstate Messaging
! Behaviors are also known as Methods

PracticePractice
Business Letter

Cell, Organ, System

CollectionsCollections
Resume
– Name
– Contact Info.
– Objective
– Skills
– Experience
– References
– Hobbies
! A Collection is a set of objects

CollectionsCollections
Experience
– Date Range
– Company
– Position
– Description

Intermission / SponsorIntermission / Sponsor

Refrigerator

Refrigerator
– Freezer Capacity
– Fridge Capacity
– Freezer Temp
– Frig Temp
– Doors
– Drawers
– Color

 cCooling Unit
– Capacity
– Temp “current”
– Maximum Temp
– Minimum Temp
– Light
– Drawers
– Door
– Color
– Dimensions

Refrigerator
– Freezer Section : cCooling Unit
– Fridge Section : cCooling Unit
Refrigerator
– cCooling Units “collection”
! A composite object is known as a Parent
! An embedded object is known as a Child

EncapsulationEncapsulation
 cCooling Unit
Behaviors for accessing data. What it is.
– GetCapacity / SetCapacity
– GetDimensions / SetDimensions
– GetTemp “current” / SetTemp
– GetColor / SetColor
Behaviors that do something. What it does.
– DoorOpen / DoorClose
– LightOn / LightOff “private”
– Draw
! Encapsulation hides the internals of data and
behaviors from other objects
! Private behaviors may not be used/called by other
objects

Parent & Child ObjectsParent & Child Objects
Draw Discussion

GlossaryGlossary
Behavior Something that an object does or can do. Some behaviors may be
invoked by other objects others are strictly for internal use only.
Also know as a Method.
Public methods may be invoked / called by other objects.
Private methods may only be invoked / called internally by the
object itself.

– Membrane
– Nucleus
! Attributes common to all cells

Common BehaviorsCommon Behaviors
– Grow
– Reproduce
– Intake Nutrients
– Output Waste
– Send Message
! Behaviors are what a object can do &
what it is responsible for

Unique BehaviorsUnique Behaviors
 Muscle
– Contract
– Relax
 Blood
– Absorb Oxygen
– Release Oxygen
 Nerve
! Unique attributes and behaviors cause
the need for Inheritance

InheritanceInheritance
 cMuscleCell : cCell
– Contract
– Relax
 cBlood : cCell
– Absorb Oxygen
– Release Oxygen
 cNerve : cCell
! An object that inherits from a base object gets
all the attributes & behaviors of the base
object PLUS any unique attributes & behaviors

Employee
– Name
– SSN
– Gender
– Contact info
– Pay Rate

cEmployee “class definition”
– Name
– SSN
– Gender
– cAddress

 cSalariedEmployee : cEmployee
– Annual Rate
– Accrued Vacation, Accrued Sick Time
 cHourlyFullTimeEmployee : cEmployee
– Hourly Rate
– Accrued Vacation, Accrued Sick Time
 cHourlyPartTimeEmployee : cEmployee
– Hourly Rate
! Look for the common attributes & behaviors.
Strategy.

Content ManagementContent Management
A form, slide layout or a skeleton doc
provides a template / class design.
Different from a WORD template (.DOT)
though, for .DOT provides styles only,
not structure.

Structured ContentStructured Content
Employee: Definition, Usage, Special Considerations

Re-use in Reference GuideRe-use in Reference Guide

 From the menu tree, select
Payroll, Maintenance,
Employee
 Employee: An employee is an
individual who is performing or
has performed work on the
company's behalf while on the
company's payroll.
 Usage: The Employee
document is used by time, unit
pricing and expense input to
record appropriate charges for
project and payroll processes.
Used for sorting, analyzing,
inquiry and reporting purposes.
 Employee Code: Provides a
unique user-defined employee
identifier.
Employee
 Employee: An employee is an
individual who is performing or
has performed work on the
company's behalf while on the
company's payroll.
 Usage: The Employee
document is used by time, unit
pricing and expense input to
record appropriate charges for
project and payroll processes.
Used for sorting, analyzing,
inquiry and reporting purposes.
 Employee Code: Provides a
unique user-defined employee
identifier.
Payroll Master Files – Employee Maintenance Foundation > Master File Setup

Payroll Master Files – Employee Maintenance Foundation > Master File Setup
Employee, General tab
 The General Information tab
contains employee-related
attributes needed to process the
employee in the ABC system
 Name: Specifies the legal name
of the employee.
 Alpha Name: Alphabetical
employee name format.
 SSN / SIN: Identifies the
employee's federal tax
identification code such as the
U.S. federal Social Security
Number or the Canadian federal
Social Insurance Number.
 Usage: Used for third party
payroll system integration.
Employee, General tab
 The General Information tab
contains employee-related
attributes needed to process the
employee in the ABC system
 Name: Specifies the legal name
of the employee.
 Alpha Name: Alphabetical
employee name format.
 SSN / SIN: Identifies the
employee's federal tax
identification code such as the
U.S. federal Social Security
Number or the Canadian federal
Social Insurance Number.
 Usage: Used for third party
payroll system integration.
 Company: Specifies the Company for which the employee primarily works.
 Usage: Used as the Company code for employee related inputs such as time,
unit pricing and expense.
 Currency: Specifies the Currency or monetary unit of the employee.
 Usage: Specifies the Currency in which the employee will be paid for payroll
purposes. An Employee may charge to any Project Currency, but will be paid
in their Employee Currency.
 Organization: Specifies the Organization for which the employee primarily
works.
 Usage: Used as the default Organization code for employee related input
such as time, unit pricing and expense.
 Company: Specifies the Company for which the employee primarily works.
 Usage: Used as the Company code for employee related inputs such as time,
unit pricing and expense.
 Currency: Specifies the Currency or monetary unit of the employee.
 Usage: Specifies the Currency in which the employee will be paid for payroll
purposes. An Employee may charge to any Project Currency, but will be paid
in their Employee Currency.
 Organization: Specifies the Organization for which the employee primarily
works.
 Usage: Used as the default Organization code for employee related input
such as time, unit pricing and expense.

Agenda recapAgenda recap
Definitions & Concepts
Simple Objects
Composite Objects
Behaviors / Methods
Responsibilities / Encapsulation
Inheritance
Content Management & Re-use

WhyWhy
 For Software Development
– facilitates re-use of code
– data hiding or encapsulation
– API = Application Programming Interface
 For Technical Writing
– facilitates re-use of content
– CMS = Content Management System
– AuthorIT
– XML

ResourcesResources
Recommended Reading
Object Technology: A Manager’s Guide
David A. Taylor
Addison Wesley
ISBN: 0201309947
Managing Enterprise Content
Ann Rockley – www.Rockley.com
New Riders
ISBN: 0735713065

ResourcesResources
Recommended Website
Ann Rockley presentations
www.Rockley.com
OOD goodies
www.java.sun.com/docs/books/tutorial/java/concepts/

GlossaryGlossary
Object “An object corresponds to a concept, abstraction, or thing that can
be distinctly identified. During analysis, objects have attributes and
may be involved in relationships with other objects. During design,
the notion of object is extended by the introduction of methods and
objects attributes. In the implementation phase the notion of object
is determined by the programming language."1
“An object is a software bundle of related variables and methods.
Software objects are often used to model real-world objects you find
in everyday life. 3
Class "A set of objects that share a common structure and a common
behavior. A class is an abstraction, which represents the idea or
general notion of a set of similar objects."1
“A class is a blueprint or prototype that defines the variables and the
methods common to all objects of a certain kind.” 3
Class
Description
"Description of the attributes, methods interface and inheritances
relationships of a class."1

GlossaryGlossary
Attribute "A set of named values associated with an object or relationship."1
Behavior Something that an object does or can do. Some behaviors may be
invoked by other objects others are strictly for internal use only.
Also know as a Method.
Public methods may be invoked / called by other objects.
Private methods may only be invoked / called internally by the
object itself.
Inheritance “A class inherits state and behavior from its superclass. Inheritance
provides a powerful and natural mechanism for organizing and
structuring software programs. ” 3
Messaging “Software objects interact and communicate with each other using
messages. ” 3

ContactContactMark Lewis
via LinkedIn
And
mlewis@ditametrics.com
Thank You!
© Mark Lewis + ©David Taylor- Object Technology content

Guest Author: ROI ChapterGuest Author: ROI Chapter
DITA 101 2nd
edition
“Fundamentals of DITA for
Authors and Managers”
By the Rockley Group
with Mark Lewis
– For sale at LuLu.com

Technical ReviewerTechnical Reviewer
Managing Enterprise Content:
A Unified Content Strategy
2nd
edition
By Ann Rockley
& Charles Cooper
– For sale at Amazon.com

DITAMetrics.comDITAMetrics.com
Book & Spreadsheets
Published by
The Rockley Group
Metrics for Intelligent
Content

ResourcesResources
It’s about metrics
…for intelligent content
– white papers
– discussions
– webinar recordings
– thought leadership

ReferencesReferences
1 Object-Oriented Development: The Fusion Method
Coleman, Arnold, Bodoff, Dollin,Gilchrist, Hayes & Jeremaes
Prentice Hall
ISBN: 0133388239
2 Object Technology: A Manager’s Guide
David A. Taylor
Addison Wesley
ISBN: 0201309947
3 www.java.sun.com/docs/books/tutorial/java/concepts/

Understanding Objects by Mark Lewis

Recommended

Recommended

More Related Content

Similar to Understanding Objects by Mark Lewis

Similar to Understanding Objects by Mark Lewis (20)

Recently uploaded

Recently uploaded (20)

Understanding Objects by Mark Lewis

Editor's Notes