Home > Articles > Programming

This chapter is from the book

8.6 Placeholders and Pattern Matching

The variables in patterns are called placeholders because they occupy the places in a pattern that are "open." Matching is a game of trying to fill the open places in a pattern with values (also called "objects") so that the instance of the pattern is identical to the event or poset that we are trying to match.

8.6.1 Matching Basic Event Patterns

A basic event pattern matches an event if when its placeholders are replaced by objects, the resulting instance of the pattern is identical to the event. Replacing placeholders with objects to make a match is subject to two conditions.

  • The type of object that replaces a placeholder must be the same as, or a subtype of, the type of the placeholder.

  • A placeholder must be replaced by the same object at all of its positions in a pattern in any one match.

For a basic pattern to match an event, it must have the same action name.

8.6.2 Placeholder Bindings

The result of a successful match of a pattern to an event (or more generally, a poset) is an association of placeholders with objects that replaced them in the instance that matched the event. This is called a binding of placeholders to objects.

A binding is usually represented as a set of pairs consisting of a placeholder and an object, <placeholder value>, meaning "replace the placeholder by the value."

Example 1: Matching bids in an RFQ process

// basic pattern 
(Vendor VId, BidId Offer) Bid(VId, Offer, EngineSpec#10, $2,000, 5000) 

// event 
Bid(Vendor#5, RF#20, EngineSpec#10, $2,000, 5000) 

// binding that results in a match 
{<VId Vendor#5>, <Offer  RF#20>} 

The pattern has the action name Bid in our supply chain events (see the declaration of Bid line in Section 8.3.4, Example 3). It has a placeholder, VId, for the Vendor parameter and a placeholder, Offer, for the BidId parameter of the Bid action. The other parameters have constant values for the ProdSpec, Price, and Quantity, so the pattern will match Bid events that have those constant values. The example shows an event and the placeholder binding that results in a match. If we replace VId by Vendor#5 and Bid by RF#20, we get an instance of the pattern that is identical to the event.

Notice in this example that constants in patterns are very restrictive. Often we want to match a range of values, say, for price or quantity, rather than one value. We will see how to do this with context guards later.

Example 2: Using a predefined attribute in a pattern

//  Pattern
    (ATM Machine M; Dollars D) Deposit(origin is M, D, Accnt#123)

//  event
Deposit(origin is ATM3, 1000, Accnt#123)

//  binding resulting in a match
   {<M  ATM3>, <D  1000>}

This pattern matches Deposit events from our ATM–Use actions (see Section 8.3.4, Example 2). The pattern contains a placeholder, M, for the predefined attribute, origin. It uses a parameter-naming notation (is), which we will discuss later.

We are assuming that in the ATM–Use system, the actual ATM can be an origin recorded in the predefined origin attribute in the events it creates. This pattern will match events from any ATM that deposit any amount to a fixed account, Accnt#123. The event in the example is a deposit originating at ATM3 of $1,000 to Accnt#123. The binding shows that M must be replaced by ATM3 and D by $1,000 to make the pattern match the event.

The golden rule about matching is that in order to match a pattern, a placeholder can be bound to only one object in all its occurrences in the pattern. So, if a placeholder occurs more than once in a pattern, a matching event or poset must have the same data at those positions.

Different matches of a pattern usually (but need not) result in different placeholder bindings.

Here are some examples of basic patterns using placeholders.

Example 3: Placeholders in basic patterns

// 1. Any transfer of any amount from and to the same account 
    (Dollars D, Account Type A) Transfer(D, A, A); 

// 2. Any event originating from ATM3 
    (event E) E(origin is ATM3); 

The first pattern has the same placeholder, A, as both the From Accnt and To Accnt parameters of a Transfer action in ATM–Use (see Section 8.3.4, Example 2). So, it will match events in which some unspecified amount of money is transferred from any account to the same account. It will match events such as the following:

Transfer(10, Accnt#123, Accnt#123),
  if the binding is {<D  $10>, <A  Accnt#123>}, 

Transfer(25, Accnt#47, Accnt#47),
  if the binding is {<D  $25>, <A  Accnt#47>}, 

The second pattern shows a powerful use of a placeholder of the pre-defined event type. It matches any event generated by ATM3. E will be bound to the event, whether it is a Deposit, Transfer, or Withdraw. This is a succinct way to write a pattern to monitor a particular ATM. If the event is

Transfer(origin is ATM3, 10, Accnt#47, Accnt#123), 

the binding is

{<E ß Transfer(origin is ATM3, 10, Accnt#47, Accnt#123)>} 

8.6.3 Notation to Aid in Writing Patterns

To emphasize the role of placeholders, Rapide-EPL allows a "?" as a prefix to a placeholder. The use of "?" is optional. It helps distinguish the variable parts of a pattern from the constant parts. Some of the previous examples of basic patterns can be written as follows:

(Dollars ?D, Account Type ?A) Transfer(?D, ?A, ?A); 
(Vendor ?VId, BidId ?Offer) Bid(?VId, ?Offer, EngineSpec#10, $2,000, 5000) 

Naming Parameters

A common error in writing a basic pattern is misordering the placeholders in the list of parameters of the action name. That is, the order of the placeholder parameters in the pattern is not consistent with the order of the parameters in the action declaration. To prevent this kind of error, each parameter in a basic pattern can be explicitly associated with the name of an action's formal parameter. You just use the parameter from the action declaration to name the parameter in the pattern. The notation for doing this is

action parameter name is pattern parameter 

This is called naming the parameters in the pattern and is an optional notation.

Example 1: A basic pattern written in named parameter form

(Dollars ?D, Account Type ?A, ?B) Transfer(To Accnt is ?A, Amount is ?D, 
                                                              From Accnt is ?B ); 

Look at the Transfer action declaration in ATM–Use (see Section 8.3.4, Example 2). The placeholder parameters in the pattern here are written in a different order from the order in which the action's parameters are declared. But it doesn't matter because we have associated each placeholder with the action's parameter that it corresponds to. So in this pattern, the To Accnt is ?A, the Amount is ?D, and the From Accnt is ?B.

Omitting Parameters

A useful feature in writing patterns is to omit a parameter whose binding is irrelevant to the matches you want. That means that you don't care about the omitted parameters, so any value will match them. But to do this without ambiguity, you must name the parameters you do use in the pattern so that it is obvious which of an action's parameters you want to include.

Example 2: Omitting action parameters

Deposit(account is Accnt#123); 
(Account Type ?A) Transfer(From Accnt is ?A, To Accnt is ?A); 

Here the Deposit pattern matches any Deposit event to account Accnt#123. We are not interested in the amount. The Transfer pattern matches any transfer from and to the same account. We are not interested in the amount of the transfer, but only the accounts where such a transfer happens.

Using an Event's Public Attributes

The public attributes of events (see Section 8.4) can be used to write more precise patterns. The attribute name is used in the named parameter form. For example, there's an attribute called the origin of an event. It denotes the component in the target system that generated the event. That component may be an object or a module or a thread, depending upon the system. The origin attribute's value can be either a name or a reference to that component.

Example 3: Monitoring all withdrawals generated at a particular ATM

Withdraw(origin is ATM3) 

Another useful public attribute is the timestamp of an event. Because timestamps are used frequently in patterns, there are special notations such as at and after, for referring to timestamps that are described later in Section 8.8.3.

Example 4: Filtering out supply chain events according to their timing

(OrderId ?Order) Order(Id is ?Order, end is 12:00) 
(RFQ ?R) RFQ(Id is ?R, Spec is EngineSpec) after 12:00 

The Order pattern will match those order events that happen over a time interval that ends at 12:00. The binding will contain the OrderId of those events.

The RFQ pattern will match those RFQ events for engine specifications that happen after 12:00 and will bind the Id of the RFQ.

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