Home > Articles > Programming > Visual Basic

  • Print
  • + Share This
Like this article? We recommend

Code the Class Modules

From the Project menu, choose Add Class Module, select Class Module from the Add Class Module dialog box, change the Name property of this new class to clsPublishersList, and save it as PublishersList.cls. Repeat this procedure to add a class for clsPublishers. Make sure the Instancing property for both classes is set to the default value of 5-MultiUse. MultiUse allows multiple objects of this class to be instantiated outside of the component. You're now ready to start writing the code to implement the necessary features.

My design has clsPublisherList and clsPublisher working closely together to provide the functionality that allows the client code that uses this component to search the Publishers table; and fetch, insert, update, and delete individual Publishers. Exactly how this is done is not quite as important as providing a correct component interface because the encapsulation rules of object-oriented programming say it's all right to change the way something is implemented as long as you don't change the interface. I usually put the code that works with more than one entity (for example, the Search method) in the list class (for example, clsPublisherList). The methods that work with a single entity (for example, Fetch, Insert, Update, and Delete) are then normally delegated to the class that encapsulates the notion of one record in the table (for example, clsPublisher).

I also make the List class responsible for using ADO to open and close the database connection. clsPublishersList can do this automatically if you add code to the Class_Intialize and Class_Terminate events:

' Private PublisherList variables.
Private mDB As ADODB.Connection

' Automatically open a database connection when a PublisherList
' object is created.
Private Sub Class_Initialize()
  Dim lConnectString As String
  lConnectString = "Driver={Microsoft Access Driver (*.mdb)};" _
    & "DBQ=" & App.Path & "\Biblio.mdb"
  Set mDB = New ADODB.Connection
  Call mDB.Open(lConnectString)
End Sub

' Automatically close the database connection when a PublisherList
' object is destroyed.
Private Sub Class_Terminate()
  Call mDB.Close
  Set mDB = Nothing
End Sub

Another method implemented by clsPublisherList is the Search method. Its job is to query the database for all Publishers whose name matches the search criteria passed as an argument. I code it like this:

' Returns a new collection containing a list of references to
' Publishers objects with a Name that matches the search criteria.
Public Function Search(ByVal lSearchString As String) As Collection
  Dim lSQL     As String
  Dim lPublisher  As clsPublisher
  Dim lPublisherCol As Collection
  Dim lRS      As ADODB.Recordset
  
  ' Build the SQL statement.
  lSQL = "SELECT * FROM Publishers " _
    & " WHERE Name LIKE " & DBStr("%" & lSearchString & "%") _
    & " ORDER BY Name"
  
  ' Query the database for the matching Publishers and create a
  ' new clsPublisher object for each record returned.
  Set lPublisherCol = New Collection
  Set lRS = mDB.Execute(lSQL)
  
  Do Until lRS.EOF = True
    Set lPublisher = New clsPublisher
    Call lPublisher.RSGet(lRS)
    Call lPublisherCol.Add(lPublisher, CStr(lPublisher.PubID))
    Call lRS.MoveNext
  Loop
  Call lRS.Close
  
  Set Search = lPublisherCol
End Function

Whenever you have SQL statements embedded in your source code that contains strings entered by the user, you always have the potential that the user will enter an apostrophe (', a.k.a. single-quote) somewhere in the string. Because this same apostrophe character is used as a delimiter within the SQL statement, it will generate SQL syntax errors if you don't write code to do something about it. I call this the "SQL embedded quote problem." The ugly solution to this problem is to modify the user interfaces so they do not allow apostrophes to be entered in string fields. However, in my opinion, a much better solution is to search through the strings when the SQL statements are built, and replace all apostrophes with two apostrophes. The DBMS then interprets the two apostrophes as just one. Because this must be done for every string passed to the database, I wrap this code in a function named DBStr and code it in a standard code module so it can be used from anywhere inside the component. For example:

' Replace each apostrophe with two apostrophes.
Public Function DBStr(ByVal lStr As String) As String
  DBStr = "'" & Replace(lStr, "'", "''") & "'"
End Function

As coded above, the Search method also relies on the clsPublisher.RSGet method to retrieve its property values from the ADO Recordset object. I put this chunk of code in the clsPublisher module because it is working with only one Publisher entity:

Friend Sub RSGet(ByVal lRS As ADODB.Recordset)
  ' Note that concatenating an empty string to the
  ' recordset fields prevents any errors caused by
  ' null fields.
  PubID = lRS!PubID
  Name = "" & lRS!Name
  CompanyName = "" & lRS![Company Name]
  Address = "" & lRS!Address
  City = "" & lRS!City
  State = "" & lRS!State
  Zip = "" & lRS!Zip
  Telephone = "" & lRS!Telephone
  Fax = "" & lRS!Fax
End Sub

Note that RSGet is declared using the Friend keyword. A procedure declared Friend can be called from anywhere within the component, but is not visible outside of the component. In this sample code, it means that RSGet can be called from clsPublisher and clsPublisherList, but it can't be called from anywhere in the PublishersWebUI project. This is good because we don't want any code outside of the DHO to query the Publishers table. Instead, we want it to use the DHO's methods.

The methods in clsPublishersList that allow individual Publishers to be fetched, inserted, updated, and deleted are pretty simple to code because they just pass control to "friend" methods in clsPublisher:

' Removes a Publisher from the Publishers table.
Public Sub Delete(ByVal lPublisher As clsPublisher)
  Call lPublisher.DBDelete(mDB)
End Sub

' Inserts a Publisher into the Publishers table.
Public Sub Insert(ByVal lPublisher As clsPublisher)
  Call lPublisher.DBInsert(mDB)
  ' If we were worried about duplicate primary keys,
  ' we would attempt to catch the error raised by
  ' the DBMS here, and re-raise a nicer message.
End Sub

' Retrieves a Publisher from the Publishers table.
Public Function Fetch(ByVal lPubID As Long) As clsPublisher
  Dim lPub As clsPublisher
  Set lPub = New clsPublisher
  lPub.PubID = lPubID
  Call lPub.DBGet(mDB)
  Set Fetch = lPub
End Function

' Updates a Publisher in the Publishers table.
Public Sub Update(ByVal lPublisher As clsPublisher)
  Call lPublisher.DBUpdate(mDB)
End Sub

Because we'll add Publisher update functionality in the sample application, here's the code for the clsPublisher.DBUpdate method:

Friend Sub DBUpdate(ByVal lDB As ADODB.Connection)
  Dim lSQL As String

  lSQL = "UPDATE Publishers SET "

  lSQL = lSQL & " Name = " & DBStr(Name) & ","
  lSQL = lSQL & " [Company Name] = " & DBStr(CompanyName) & ","
  lSQL = lSQL & " Address = " & DBStr(Address) & ","
  lSQL = lSQL & " City = " & DBStr(City) & ","
  lSQL = lSQL & " State = " & DBStr(State) & ","
  lSQL = lSQL & " Zip = " & DBStr(Zip) & ","
  lSQL = lSQL & " Telephone = " & DBStr(Telephone) & ","
  lSQL = lSQL & " Fax = " & DBStr(Fax)
  
  lSQL = lSQL & " WHERE PubID = " & CStr(PubID)

  Call lDB.Execute(lSQL)
End Sub

Note that this procedure also is coded using the Friend keyword so that all requests to update a publisher must go through the Public clsPublisherList.Update method first. clsPublisher.DBUpdate also uses the DBStr function mentioned earlier to avoid the SQL embedded quotes problem.

The DBFetch, DBDelete, and DBInsert methods of clsPublisher are coded very much the same as DBUpdate, and so aren't listed here for brevity sake. Download the sample project source code if you want to see how they are implemented.

  • + 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