Home > Articles > Programming > Java

This chapter is from the book

This chapter is from the book

The TreePath Class

If DefaultMutableTreeNode is the physical representation of a node, then TreePath is its logical representation. Instead of pointing you directly at the node, it tells you the node's "address" within the tree. So long as the node itself and its parents are not moved within the tree, its TreePath will remain constant and can always be used to address it. TreePath has two public constructors:

public TreePath(Object singlePath) public TreePath(Object[] paths) 

A TreePath stores an array of objects that describes the path to a node. The second constructor sets up this array from its argument, while the first is a convenience method that creates an array of length 1 and initializes it with the single object passed as the argument. TreePath has the following methods:

public boolean equals(Object) 
public Object getLastPathComponent(); 
public Object getPathComponent(int index); 
public int getPathCount(); 
public Object[] getPath(); 
public TreePath getParentPath(); 
public TreePath pathByAddingChild(Object child); 
public boolean isDescendant(TreePath treePath) 
public String toString() 

None of these methods are concerned with what the objects that the TreePath stores actually are—they just treat them as anonymous objects. The equals method returns true if the object passed as its argument is another TreePath with an object array of the same length as its own and for which the result of comparing each object in its own array with the corresponding object in the other array (using the equals method the objects being compared) returns true.

The getPath method returns the array of objects installed by the constructor, while getLastPathComponent returns the last object in the array. In the case of a TreePath representing a set of directories from a file system tree ending in a file, this method would return the object that corresponds to the file itself. Similarly, getPathCount returns the number of objects in the path and getPathComponent returns a single component of that path given its index, where 0 is the component at the root. getParentPath returns a TreePath object representing the parent of the TreePath against which it is invoked. pathByAddingChild creates and returns a TreePath object that represents the results of appending the Object passed as its argument to the current TreePath. In terms of the file system tree, if you invoked this method against the TreePath for a node representing directory and passed it an Object representing a file or subdirectory within that directory, it would return a TreePath for that file or subdirectory.

The isDescendant method determines whether the TreePath passed as its argument represents a descendant of the TreePath against which it is invoked. This will be true if the TreePath passed as the argument has at least as many objects in its array as the TreePath against which this method is invoked, and each of the objects in the invoked TreePath's array is equal to the corresponding object in the array of the proposed descendant. Finally, the toString method prints a readable representation of the TreePath by invoking the toString methods of each object in its array and concatenating them, separated by commas.

The TreePath doesn't care what the objects that it manipulates are, but you need to know what they are in order to make much use of a TreePath. The objects that TreePath actually stores are the TreeNodes for each node of the tree between the root and the object that the TreePath relates to. In most cases (and in all of the examples in this chapter), this object will actually be a MutableTreeNode. This means that, in an event handler that receives a TreePath in its event, you can access the information from the data model that the event relates to, including the user object associated with the node, simply by getting a reference to the node from the TreePath. You'll see when looking at the file system tree component that is developed later in this chapter why this is a useful feature.

Let's look in more detail at what a TreePath is made up of by using an example. TreeExample2 is a development of the last example in which the tree is built and then, every 30 seconds, the TreePath object for whatever is on row 4 of the tree's display is obtained and its content is printed. Here is the interesting part of this program:

for (;;) { 
  Thread.sleep(30000); 

  // Get TreePath for row 4
  TreePath p = t.getPathForRow(4);
  if (p == null) { 
    System.out.println("Nothing on row 4!");
    continue; 
  } 

  // Print the official description of "p" 
  System.out.println("===================\n" + p); 

  // Now look inside
  Object[] o = p.getPath();
  for (int i = 0; i < o.length; i++) { 
    System.out.println("Class: " + o[i].getClass() +
       "; value: " + o[i]);
    if (o[i] instanceof DefaultMutableTreeNode) { 
     Object uo =
          ((DefaultMutableTreeNode)o[i]).getUserObject();
     if (uo != null) {
       System.out.println("\tUser object class: " +
         uo.getClass() +"; value: " + uo);
     }
    }
  }
}

The TreePath for whatever is on row 4 is obtained by using the get-PathForRow method of JTree. If the row is empty, as it will be when you start the program, this method returns null, so a message is printed and nothing further happens for another 30 seconds. Otherwise, the TreePath toString method is used to see its own description of itself, then getPath is called to get its array of component parts. For each object returned in this array, its Java class and its value are printed. Finally, if any object that is obtained from the array is a DefaultMutableTreeNode, its getUserOb-ject method is called to get the user object associated with the node and, if there is one, its class and its value are also printed. You can run this example yourself by typing:

java JFCBook.Chapter10.TreeExample2 

Following are the results of three iterations around the loop with three different directories expanded to place different objects on row 4 of the display.

 [null, Skylab, 3] 
Class: class javax.swing.tree.DefaultMutableTreeNode; value: null
Class: class javax.swing.tree.DefaultMutableTreeNode; value: Skylab
      User object class: class java.lang.String; value: Sky-
Lab
Class: class javax.swing.tree.DefaultMutableTreeNode; value: 3 
       User object class: class java.lang.String; value: 3 
 [null, Apollo, 13]
Class: class javax.swing.tree.DefaultMutableTreeNode; value: null 
Class: class javax.swing.tree.DefaultMutableTreeNode; value: Apollo
       User object class: class java.lang.String; value:
Apollo 
Class: class javax.swing.tree.DefaultMutableTreeNode; value: 13
       User object class: class java.lang.String; value: 13 
 [null, Apollo, 12, Pete Conrad] 
Class: class javax.swing.tree.DefaultMutableTreeNode; value: null 
Class: class javax.swing.tree.DefaultMutableTreeNode; value: Apollo 
       User object class: class java.lang.String; value: 
Apollo 
Class: class javax.swing.tree.DefaultMutableTreeNode; value: 12 
       User object class: class java.lang.String; value: 12 
Class: class javax.swing.tree.DefaultMutableTreeNode; value: Pete Conrad 
       User object class: class java.lang.String; value: Pete 
Conrad 

The toString method of TreePath prints the path to the node that was on row 4. Next, the objects that correspond to the various parts of the path are shown. As you can see, there is one object for each node in the path, starting at the root and ending with the node that corresponds to the Tree-Path. As noted above, these objects are actually the nodes that were stored in the DefaultTreeModel, so they are all instances of DefaultMutable-TreeNode and invoking toString on them prints the string that was supplied to the constructor that created them. Finally, each of these nodes, apart from the root node, has an associated user object that, as you can see, is the same string. This is not, however, a surprise, because the DefaultMutable-TreeNode constructor that was used described its argument as the user object associated with the node. In fact, the toString method of Default-MutableTreeNode just invokes the toString method of the user object if there is one and returns an empty string if there isn't. This explains why the DefaultMutableTreeNode returns the string passed to its constructor.

Incidentally, we now have the information needed to modify one of our earlier example programs so that the string root doesn't appear next to the root node on the display, as it did in Figure 10–7. In that example, the root nodes were not explicitly created by the program: Because each JTree was built by passing a Hashtable to its constructor, the root nodes were built for us. The string displayed for the root node is the result of invoking toString against that node. You now know that, because this node is a DefaultMu-tableTreeNode, its toString method will delegate to that of its user object if there is one and return an empty string otherwise. When the root nodes in Figure 10–7 were created, the string root was assigned as the user object, so to make it disappear, you just have to use the setUserObject method to set the user object to null.

Here is how you would create a tree that shows a root folder without the root label:

JTree t = new JTree(h);
t.setShowsRootHandles(false);
t.setRootVisible(true); 

// Remove the 'root' label 
Object rootNode = t.getModel().getRoot(); 
((DefaultMutableTreeNode)rootNode).setUserObject(null); 

This code gets a reference to the model from the JTree using the get-Model method and then gets the root node from the model by using the TreeModel getRoot method. This method is defined to return an Object, but you know that the root node is a DefaultMutableTreeNode, so all you have to do is cast it and use setUserObject to remove the root string. You can use the same technique to assign an arbitrary label to the root node. You can see how this works in practice using the command

java JFCBook.Chapter10.HashHandleTree3 

which produces the same result as that shown in Figure 10–7, except that the root nodes do not have any associated text.

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