Development Tools

• Code/Help Repository:
  • Getting the code
  • Developing with Git
  • Merging a PR
  • Git FAQs
  • Intro to GitHub Desktop
• Building Tools:
  • Ant
  • NetBeans
  • Eclipse
  • IntelliJ IDEA

Code Structure

• Introduction
• Names and Naming
• Application Structure
• Code Structure Patterns
• Swing Structure
• External Connection Structure
• Application Preferences
• Profile Files
• Threading
• Use of XML
  • XML Schema
  • XSLT Formatting
• Web Site
• Javadocs
  • Name Index
  • Packages
  • Classes

Techniques and Standards

• Recommended Practices
• Continuous Integration
• Internationalization
• Logging & Error Handling
• Unit testing with JUnit
• Documentation using Javadoc and UML
• Run the SpotBugs static analysis tool
• Providing help using JavaHelp
• Portable Filename Method
• XML Persistance

Help and Web Site

• Providing Help using JmriHelp
• The JMRI Web Site
• Updating JMRI Web and Help
• Creating Help for New Hardware
• Program Documentation Using Javadoc

How To

• Extend JMRI
• Add a New System
• Add a New Type

Functional Info

• Turnout Feedback
• Network Connections
• How the startup scripts work

Background Info

• Technology Roadmap
• Survey of JVM Capabilities
• Usage Poll, Spring 2007

Donate to JMRI.org

JMRI: Names and Naming

This page discusses how JMRI objects are named, how those names are used to reference the objects (hardware and software), and how user-readable names are used.

What's in a name?

1. When working with user input, e.g. typing a number in a field, the code will need to know how to map the user-provided info onto objects. Sometimes the user will want to name objects with arbitrary user names, e.g. "East Lockport Turnout". These can't be known until their mapping to hardware has been made. But other times these will be de-novo identifications that the code must understand, e.g. something that means "LocoNet Turnout 23".
2. We imagine that configurations will be stored in XML files, in a symbolic form. Names are a convenient way to connect objects and object references in that kind of configuration.

Items with names

There are lots of things that might need names, such as Turnouts, Sensors, and other layout elements. Some of these are associated with a specific hardware device, e.g. a particular turnout. Others are more virtual, e.g. a route, which is a collection on control information within the program. A list of named types follows below.

System and User Names

JMRI users both "system names" and "user names" to reference things.

We want users to be able to call things what they want. Names like "p(24,23)*" are not useful. Every named item can therefore have a "user name", which is an entirely free-form string. You can put whatever you want in there, so long as it's not a duplicate of the user name given to something else. For example, you might call a Turnout "West Yard Lead" or "Turnout 32" or "Green Wire from Controller" or whatever.

At the same time, we need a shorthand name, really a unique identifier, to talk about specific objects. This doesn't have to be convenient, but does have to have a clear mapping from name to object and back. For example, we need a very specific way to identify "LocoNet Turnout 23". We call these "system names." JMRI code will map these to and from whatever information the hardware may need.

System Name Format

• The connection prefix is a single uppercase or lowercase letter, optionally followed by one or more digits. Therefore, "S," "s", "S2," and "s2" are all examples of valid -- and different -- connection names. Special characters are not allowed. This simple form allows us to always find the connection prefix and type letter even if we don't know the full list of hardware systems involved. Default values for different hardware systems are listed below.
• The type letter defines the type of model-railroad object, such as (T)urnout or (S)ensor, see below.
• The suffix string is related to the hardware addressing for the specific hardware system, but is otherwise unconstrained. Some are simple numbers, such as a device address. Others are much more complicated strings to carry more complex information.

Examples:

• LT23 - LocoNet Turnout 23.
• L2T23 - Turnout 23 on the second LocoNet connection.
• CS2012 - A C/MRI Sensor (input line) addressed as 2012, which means the 12th pin on on the node with address 2.

Connection Prefix

The JMRI code is much more flexible than that, however. This allows it to deal with multiple system connections and overlaps of letters (such as the multiple possibilities defined for "D" or "M" below). You change the letter associated with a system connection in the preferences to any other uppercase or lowercase letter. You can call your NCE connection "P" if you want to. If you have two of them, you can call one "X" and the other "Y". You can also use a lower case or upper case letter followed by digits, e.g. "N1" and "n2".

Note:

• OBlocks always use OB
• Transponding tags always use LD
• RailComm tags always use RD

Default Connection Letters

Note that some of these are placeholders, and have no underlying implementation. (Links are to JMRI pages with more information)

Also note that some older implementations used formats that don't meet the current standard, with connection letters such as "DX", "DCCPP", "DP", "MR", "MC", "PI", "TM". These need to be migrated, and we have a have a process in place to do that.

• A CTI Acela, Bachrus Speedometer
• B Direct DCC control
• C C/MRI serial
• D SRCP,
  Anyma DX512
  DCC++ (previously written DCCpp)
  DCC4PC
• E EasyDCC
• F RFID tag readers
• G ProTrak Grapevine
• H
• I Internal, e.g. objects with no associated hardware
• J JMRI network connections
• K Maple Systems
• L LocoNet
• M Model railroad layout control buses, including OpenLCB and CBUS®
  Model Rectifier Corp (MRC)
  Marklin CS2
• N NCE (also Wangrow currently)
• O Oak Tree Systems
• P Powerline transmission, e.g. X10 and Insteon,
  Raspberry Pi native pins
• Q QSI programmer interface
• R RPS system
• S SPROG
• T Lionel TMCC,
  TAMS
• U ESU ECoS
• V TracTronics SECSI
• W (reserved for Wangrow, but that's currently still combined with NCE)
• X XpressNet used by a number of Lenz, Atlas, Hornby and other connections
• Z ZimoMX-1, IEEE802.15.4 and Z21 connections

Device type letters

• A Audio - an internal software object that holds information about a sound sample to be placed at a specific position in 3d space
• B Block - A software object that keeps track of the contents of a specific block of track. Block system names mostly, but not always, start with IB.
• C String - A string of Characters, like a text or a file name.
• D iDentity - A software object that holds information about an identity tag that is, typically, attached to a piece of rolling stock. These objects are not system-specific but are Internal objects, hence have system names commencing with ID. The underlying hardware will use Reporter objects to communicate back to JMRI when a specific iDentity object has been seen.
• F signal system - defines the aspects that can be used by signal Masts implementing this system
• F signal mast (A signal mast contains Groups of signal Heads and F comes before G and H)
• G signal Group - A set of signal Heads to a main masts. For new items using IG at the start is recommended; the example name is "IG12". For historical reasons, Groups were not required to have a system prefix or type letter until late; Since JMRI 4.13.4Using only one single letter in the system name is no longer compatible with system name validation.
• H signal Head - One part of a signal (which may have multiple heads). Also interpreted to include indicators on control panels that are acting to display signal aspects. SignalHead system names mostly, but not always, start with IH.
• L Light - another form of output, used to e.g. control lights on a layout
• M Memory - As yet, this has no real equivalent in the layout hardware, but is used as a place to store information temporarily and display it on panels, etc. Memory system names mostly, but not always, start with IM.
• N eNtry/exit destination points
• O rOutes - a tool for setting multiple Turnout states at once. Prior to version 4.19.2, the "R" letter was shared between Reporters and Routes.
• P Power manager i.e. layout, district, subdistrict; not all systems distinguish between these, so the device type letter doesn't either. The system-specific part of the name can. For example, the system specific part might be B for main layout power, e.g. LPB or S42 for subdistrict channel 2 on card 4, e.g. LPS42.
• Q LogixNG - Logix Next Generation - a set of logic equations used to control the layout. LogixNG system names start with IQ.
• R Reporters - a general purpose mechanism for reporting complicated information from the layout, e.g. locomotive identification from some transponding hardware, RFID tag numbers, etc.
• S Sensors - general purpose input sensors that can generally be either ACTIVE or INACTIVE. This is most commonly used for block occupancy detectors.
• T Turnout - actually a general purpose output on the layout
• V Analog value - An item that can have an integer value or a floating value. For example a current meter. The letter V is for Variable.
• W Warrant - a collection of information sufficient to run an automated train.
• X logiX - a set of logic equations used to control the layout. Logix system names mostly, but not always, start with IX.
• Y sections - holds a map of trackwork. Section system names mostly, but not always, start with IY.
• Z transit - a group of Sections representing a specified path through a layout. Transit system names mostly, but not always, start with IZ.

System-specific suffix

"Internal" objects can also be addressed and manipulated, but they don't have a strict correspondence with some hardware on the layout. For example, if a signal head is implemented as three different outputs, LT1, LT2 and LT3, the signal head object might be called IH3.

Each different hardware system can specify the "suffix string" that follows the connection and type letters. Generally, these are small numbers, but their exact meaning is very system-specific. For more information, please see the specific pages for

• C/MRI
• Digitrax LocoNet
• Grapevine
• Lenz XPressNet
• CBUS
• NCE
• Powerline adapters, e.g, X10, Insteon

(If you find any missing or see omissions in the following summary, please add a reference)

Adding an item to the table - Entry Format Summary

When you add an item to one of the tables, many times you only have to enter the numbers (the suffix) and JMRI will construct the complete system name.
Here's a summary of the options per Connection, split up for outputs (eg. Turnouts) and inputs (eg. Sensors):

Naming Conventions For Automated Use

SENSOR GROUP:my group:LS1
SENSOR GROUP:my group:LS2

To make this possible, two informal rules are used:

• Users should not use the : (colon, ASCII 0x3A), " (double quote, ASCII 0x22), nor $ (dollar sign, ASCII 0x24) characters in their system or user names. Automatic tools should use at least one of these to make sure they don't collide with user-selected names. Quotes should always be used in pairs to allow nesting.
• Tools that use this method have their tool name in any system names they create, as "SENSOR GROUP" was used above.

The list of tools currently working this way is:

• Logix - auto-generated Logix system names are of the form IX:AUTO:0001
• SENSOR GROUPS - jmri.jmrit.sensorgroup
• SignalHeads - particularly the SE8C signal head
• USS CTC - jmri.jmrit.ussctc

Notes

• Some devices are not really named, as there's no idea of more than one yet. The DCC programmer is the first example, but there may be others.
• Conditionals are a special case. Although they have things called "System Names" and "User Names", they don't really obey the conventions here. See the ConditionalManager Javadoc for more information.
• The system name convention does not provide a specific way to identify more than one adapter of a given type. E.g. if you're connected to more than one LocoNet, or more than one command station of any single type, you can either give the second one a separate letter (L, then M) or you can identify the 2nd one with a modifier (L, then L2). That's a bit ambiguous, but there are proponents of both approaches so we make them both available.
• There's no provision for a single program to deal with more than one layout. If that's needed, we'll have to understand what the program is trying to do.

For Programmers

Normalized form of Names, and how to work with it

The code to make sure that names are in normal form has been localized to a single routine for user names:

 String userName = NamedBean.normalizeUserName(input);

Please use that, and only that, when creating a user name from human input or other source. Do not explicitly call String#toUpper(), String#strip() or any other formatting operation; having those spread across the code is unmaintainable.

Because system names may vary from type to type and manager to manager, there are two manager-specific methods of interest: manager.validateSystemNameFormat(input, locale) and manager.makeSystemName(input). Since most NamedBeans are created by managers, and managers know about the complete set of NamedBeans, that's the right place to put them. But it means that an individual NameBean, i.e. jmri.jmrix.internal.InternalTurnout, constructor can't access it. If one of those constructors discovers it can't parse a provided system name argument because it's invalid, it should throw a NamedBean.BadSystemNameException. The constructor should not in any way transform the system name that it was given. It has to use it as given or, if it can not, throw the exception.

For more information, see the Javadoc for normalizeUserName, validateSystemNameFormat, makeSystemName, BadUserNameException, and BadSystemNameException.

In general, it's better to use an input method that already handles all this. Two are available now:

• JComboBox format:
  

  import jmri.swing.NamedBeanComboBox;
  
  // the first argument is the manager
  // the 2nd is a bean to select or null
  // the third determines how the beans are displayed
  selectComboBox = new NamedBeanComboBox(InstanceManager.getDefault(SensorManager.class),
    currentSensor, NamedBean.DisplayOptions.DISPLAYNAME)
  
  // to get the selected item:
  selectComboBox.getSelectedItem()
  

• Table format:
  

  import jmri.jmrit.picker.*;
  PickListModel tableModel = PickListModel.sensorPickModelInstance(); // or another type
          PickSinglePanel panel = new PickSinglePanel(tableModel);
  
  // to get the selected item as a NamedBeanHandle<T>
  panel.getSelectedBeanHandle();
  
  // you can listen for a selected value by
  // inheriting from ListSelectionListener
  // and registering with
  // panel.getTable().getSelectionModel().addListSelectionListener(this)
  @Override
  public void valueChanged(ListSelectionEvent e) {
      System.out.println("  Selected: "+panel.getSelectedBeanHandle());
  }
  

  This allows the user to select either the system name or (non-blank) user name in a row, which then becomes the preferred name for the resulting NamedBeanHandle. For more information on NamedBeanHandle, including how to get them from the NamedBeanHandleManager see the page on code patterns page.

System Name Comparisons

System names are compared and sorted in multiple places: as labels for table rows, in selection boxes and lists, etc. We have two java.util.Comparator<> implementations to handle this:

• NamedBeanComparator - a comparison on the NamedBeans themselves
• SystemNameComparator - a comparison on Strings (deprecated)

Please use one of these whenever you need to compare or sort by system names to keep the complexity in one place.

Both of them sort first by system connection prefix, to group all the objects from one system together. If there are objects of multiple types, the type letter is put in alphabetical order next. Finally, the system-specific suffix is sorted.

NamedBeanComparator is the standard method going forward as it can do type-specific sorting of the suffix part of the names: It knows what the C/MRI suffixes in "CT2003" and "C2B2" mean and can take that into account.

Because it works with String values, SystemNameComparator could only do a default ordering of the system-specific suffix; it couldn't do anything that uses any information about the system-specific meaning of that string. It therefore uses an alphanumeric-by-chunks sort. Because it's comparing on the actual NamedBean objects, NamedBeanComparator can do more specific comparisons.

Also, if you've created a system that has complex information in the suffix, please have your NamedBean subclasses implement a system-specific version of the compareSystemNameSuffix() method in NamedBean. For an example, see the bottom of jmri.jmrix.cmri.serial.SerialTurnout and jmri.jmrix.cmri.serial.SerialTurnoutTest.

CBUS® is a registered trade mark of Dr Michael Bolton.