Home > Articles > Programming > Windows Programming

  • Print
  • + Share This
This chapter is from the book

Designing Objects Using Encapsulation

So far, the information provided has been used in simple examples. By now, you should understand encapsulation principles but probably don't have a firm grasp on how it's used in object design and the creation of real-world object classes.

Think about the real-world instance of an application that deals with a database. This example uses a book database that stores a list of books and authors. The application you are creating deals with the list of books in several different areas of the application, and some developers working on the application don't have much knowledge about databases.

The goal is to design a class that encapsulates a list of books and all the functionality required to query the list from the database while providing a simple interface to retrieve the data. With this class, any area of the application and any developer could retrieve the list of books without any knowledge of the underlying database or how it works. Also, the database code could change, and it would require a single class to change instead of several modules in a large application.

The design of class Books is shown in the UML diagram in Figure 3.1. The BookData class is defined within the Books class as Private and isn't accessible for use outside the Books class.

Figure 3.1 UML class diagram of Books class.

Without getting into how things are implemented in the Books class, concentrate on the public interface of the class. Listing 3.4 has all the public interfaces defined for the Books class.

Listing 3.4 Book.vb: Books Class Definition of Public Interface

Public Class Books
    Implements IDisposable

 'Private members for internal usage
 Private SqlCommand As SqlClient.SqlDataAdapter
 Private QueryData As BookData
 Private CurrentRow As Int32

 'Public New() interface for constructing the object
 Public Sub New()
  strTitle = Nothing
  strAuthor = Nothing
  dPrice = 0
  CurrentRow = -1

  SqlCommand = New SqlClient.SqlDataAdapter()
  SqlCommand.SelectCommand = New SqlClient.SqlCommand()
  SqlCommand.TableMappings.Add("Table", BookData.BOOK_TABLE)
 End Sub

 'Public dispose interface
 Public Overridable Sub Dispose() Implements IDisposable.Dispose
  Dispose(True)
  GC.SuppressFinalize(True)
 End Sub

 'Public Query method provides the user of the object a method to
 'start the query of the books in the database
 Public Sub Query()
  If Not QueryData Is Nothing Then
   QueryData.Dispose()
  End If

  CurrentRow = 0
  QueryData = New BookData()

  With SqlCommand
   Try
    With .SelectCommand
       .CommandType = CommandType.Text
       .CommandText = "SELECT title, au_lname, price FROM " & _
           BookData.BOOK_TABLE
       .Connection = New System.Data.SqlClient.SqlConnection( _
           "data source=(local)\NetSDK;initial catalog=pubs;" & _
           "persist security info=False;user id=sa;")
    End With
    .Fill(QueryData)
   Finally
    If Not .SelectCommand Is Nothing Then
     If Not .SelectCommand.Connection Is Nothing Then
      .SelectCommand.Connection.Dispose()
     End If
     .SelectCommand.Dispose()
    End If
    .Dispose()
   End Try
  End With
 End Sub

 'The public Fetch method provides the object user a method
 'of fetching each record that was returned from the query
 'The results are loaded into members for access via public properties
 Public Function Fetch() As Boolean
  Fetch = False

  If CurrentRow < 0 Then
   Exit Function
  End If

  With QueryData.Tables(BookData.BOOK_TABLE).Rows

   'If there are no more records, exit
   If CurrentRow >= .Count() Then
    CurrentRow = -1
    Exit Function
   End If

   Try
    strTitle = CType(.Item(CurrentRow).Item(BookData.TITLE_COLUMN), _
      String)
    strAuthor = CType(.Item(CurrentRow).Item(BookData.AUTHOR_COLUMN), _
      String)
    dPrice = CType(.Item(CurrentRow).Item(BookData.PRICE_COLUMN), _ 
      Double)
   Catch
    'Do nothing...
   Finally
    Fetch = True
    CurrentRow += 1
   End Try

  End With
 End Function

#Region " Property Definitions "

 Private strTitle As String
 Private strAuthor As String
 Private dPrice As Double

 'The public properties provide read only access to the
 'data returned from the query after each call to Fetch()
 Public ReadOnly Property Title() As String
 Get
  Title = strTitle
 End Get
 End Property

 Public ReadOnly Property Author() As String
 Get
  Author = strAuthor
 End Get
 End Property

 Public ReadOnly Property Price() As String
 Get
  Price = dPrice.ToString("c")
 End Get
 End Property

#End Region

End Class

You can compare the class definition to the UML class diagram in Figure 3.1 and get an idea of the interface. Adding the additional protected and private code to the class as shown in Listing 3.5 completes the Books class definition.

Listing 3.5 Book.vb: Books Class Definition of Private and Protected Interfaces

Public Class Books
    Implements IDisposable

  'Private members for internal usage
  Private SqlCommand As SqlClient.SqlDataAdapter
  Private QueryData As BookData
  Private CurrentRow As Int32

  'Public New() interface for constructing the object
  Public Sub New()
    ...
  End Sub

  'Public dispose interface
  Public Overridable Sub Dispose() Implements IDisposable.Dispose
    ...
  End Sub

  'Protected dispose for internal class usage
  Protected Overridable Sub Dispose(ByVal disposing As Boolean)
   If Not disposing Then
     Exit Sub ' we're being collected, so let the GC take care of
         ' this object
   End If

   If Not SqlCommand Is Nothing Then
      If Not SqlCommand.SelectCommand Is Nothing Then
        If Not SqlCommand.SelectCommand.Connection Is Nothing Then
         SqlCommand.SelectCommand.Connection.Dispose()
        End If
        SqlCommand.SelectCommand.Dispose()
      End If
      SqlCommand.Dispose()
      SqlCommand = Nothing
   End If
  End Sub

  'Public Query method provides the user of the object a method to 
  'start the query of the books in the database
  Public Sub Query()
   ...
  End Sub

  'The public Fetch method provides the object user a method
  'of fetching each record that was returned from the query
  'The results are loaded into members for access via public properties
  Public Function Fetch() As Boolean
   ...
  End Function

#Region " Property Definitions "

  Private strTitle As String
  Private strAuthor As String
  Private dPrice As Double

  Public ReadOnly Property Title() As String
  Get
   Title = strTitle
  End Get
  End Property

  Public ReadOnly Property Author() As String
  Get
   Author = strAuthor
  End Get
  End Property

  Public ReadOnly Property Price() As String
  Get
   Price = dPrice.ToString("c")
  End Get
  End Property

#End Region

  'The BookData class provides a DataSet that represents the data 
  'returned from the query
  <SerializableAttribute()> Private Class BookData
      Inherits DataSet

   Public Const BOOK_TABLE As String = "TitleView"
   Public Const TITLE_COLUMN As String = "title"
   Public Const AUTHOR_COLUMN As String = "au_lname"
   Public Const PRICE_COLUMN As String = "price"

   Public Sub New(ByVal info As SerializationInfo, _
       ByVal context As StreamingContext)
     MyBase.New(info, context)
   End Sub

   Public Sub New()
     MyBase.New()
     BuildDataTables()
   End Sub

   Private Sub BuildDataTables()
     '
     ' Create the Books table
     '
     Dim table As DataTable = New DataTable(BOOK_TABLE)

     With table.Columns
        .Add(TITLE_COLUMN, GetType(String))
        .Add(AUTHOR_COLUMN, GetType(String))
        .Add(PRICE_COLUMN, GetType(Double))
     End With

     Me.Tables.Add(table)
   End Sub
  End Class
End Class

The Books class obviously has a significant amount of code to provide the implementation logic needed by design. The good part is that the Books class user has very little code to write to retrieve a list of books. The use of the Books class is shown in the following code segment:

Public Sub MySub()
  Dim BookQuery As Books = New Books()

  BookQuery.Query()
  While BookQuery.Fetch()
   'Do something with data by accessing the properties within 
   'the Books object
  End While

End Sub

By building classes, such as Books, and encapsulating as much functionality as possible within the class, you can create complex applications with little code.

When a new instance of the Books class is created and assigned to the BookQuery object, all the initialization in the Books.New() constructor is executed. You can see how much code you would have to write repeatedly to duplicate the functionality without the Books class.

When the Books.Query() method is called, a SQL connection is made to a SQLServer, and a query is executed to bring back a list of books with author names and prices. The query results are saved in a DataSet for future processing. Users of the Books object execute only one statement while the class implementation takes care of all the dirty work in dealing with the database.

Finally, the users process the results of the query by repeatedly calling the Books.Fetch() method until it returns false. After each call to Fetch(), the Books object properties are set to the current record, and users can retrieve those values with the property methods.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020