Skip to content

Latest commit

 

History

History
executable file
·
157 lines (102 loc) · 6.11 KB

Exercise_Solutions.md

File metadata and controls

executable file
·
157 lines (102 loc) · 6.11 KB
Raw

Solutions

Understanding NIEM Objects

Q: What happens if maxOccurs is less than minOccurs?

A: A validating XML editor will throw an error.

Q: What do you think happens if maxOccurs is set to zero? Why might you want to do that?

A: The element is disallowed. It's handy if you want to temporarily remove an object from an exchange, perhaps during testing, without actually deleting it from the schema. Of course, you could also just comment it out.

Q: What are some cases where you might want a maxOccurs that is greater than 1, but not unbounded?

A: Fingerprints is a good example. While some folks have more than ten fingers, there is a realistic upper bounds on how many a person can have. Your database might also have upper limits on how often something can occur. Maybe you only support 3 address lines. You might then limit that element in an exchange to a maxOccurs of 3.

Native Properties

Open-ended exercise.

Substitution Groups

Q: What are all the different ways that NIEM can represent a date?

A: nc:DateRepresentation can be replaced with:

  • nc:Date: A full date.
  • nc:DateRange: A time period measured by a starting and ending point.
  • nc:DateTime: A full date and time.
  • nc:DayDate: A day date.
  • nc:FiscalYearDate: A year of a twelve month period that does not necessarily correspond to the calendar year.
  • nc:MonthDate: A month.
  • nc:QuarterID: An identifier of a three-month period in a calendar or fiscal year.
  • nc:YearDate: A year.
  • nc:YearMonthDate: A year and month.
  • nc:ZuluDateTime: A date and time with no offset from Coordinated Universal Time (UTC).

Q: Take a look at the following elements and how they fit together via substitution groups. What do you think the reason for all this might be?

  • nc:Entity
  • nc:EntityRepresentation
  • nc:EntityOrganization
  • nc:EntityPerson

A: Some sorts of things can be either a person or an organization. Think j:CaseDefendantParty (SSGT/Wayfarer)

Inherited Properties

Q: How could you indicate a vehicle is a commercial vehicle? Can you find a second way?

A: Use a nc:CommercialVehicle element to represent it. Use nc:VehicleCMVIndicator and set it to true.

Q: How could you describe the brand name of a commercial vehicle as text rather than a code?

A: nc:ItemBrandName

Q: How could you indicate the primary color of a commercial vehicle? Can you find a second way? A third? A fourth?

  • nc:ItemColorDescriptionText
  • nc:ConveyanceColorPrimaryText
  • cbrn:ConveyanceColorPrimaryCode
  • j:ConveyanceColorPrimaryCode

Associations

Q: How might you associate a person with their aunt or uncle? (Hint: "Facet" is the term the SSGT uses for code table codes. Play with the search options there to find this. Wayfarer won't be a help with this.)

A: hs:PersonOtherKinAssociation. Find this by searching "Facets" for "aunt" or "uncle" in the SSGT, then see what contains that code table. The resulting XML might look like this:

<hs:PersonOtherKinAssociation>
	<hs:PersonOtherKinAssociationCategoryCode>Paternal Uncle</hs:PersonOtherKinAssociationCategoryCode>
	<hs:SourcePerson>
		<nc:PersonName>
			<nc:PersonGivenName>Me</nc:PersonGivenName>
		</nc:PersonName>
	</hs:SourcePerson>
	<hs:TargetPerson>
		<nc:PersonName>
			<nc:PersonGivenName>My Uncle</nc:PersonGivenName>
		</nc:PersonName>
	</hs:TargetPerson>
</hs:PersonOtherKinAssociation>

Roles

Q: How many kinds of roles can an "item" play? What are they? (Hint: "Kinds of roles" refers to types.)

A: There are six different types that a RoleOfItem can be in:

Q: How many different elements can represent these kinds of roles? What are they? (Hint: Wayfarer is the best tool for this.)

A: Wayfarer can show all the elements that are of or derived from any of these types.

Code Tables

Q: Going back to the primary color of a commercial vehicle, is there any difference between the different code table options?

A: Yes, one uses abbreviations, the other full words. These are quite similar, in terms of conceptual colors, but other similar tables can vary widely.

Q: Why might there be all these different code tables for this? (You won't be expected to actually know this, but it's good to ponder it.)

A: Different domains have different preferences and requirements. NIEM's domains allow them to each do it their own way.

Q: Find all the values for a person's eye color.

A: They're all listed at PersonEyeColorCodeSimpleType:

  • BLACK
  • BLUE
  • BROWN
  • GRAY
  • GREEN
  • HAZEL
  • MAROON
  • MULTICOLORED
  • PINK
  • UNKNOWN

Q: What if you wanted to describe the eye color as "The color of my favorite pair of faded blue jeans"?

A: Most code tables have a textual counterpart, in this case nc:PersonEyeColorText

Q: What do you think happens if a code table has no enumerations defined? What will validate and what won't?

A: Any string will validate!

Metadata

Q: What does the Human Services domain count as metadata?

A: It's all listed here: hs:Metadata

Q: What about the Screening domain?

A: Screening only has Person-oriented metadata: scr:PersonMetadata

Q: Think up an example of metadata about this class.

A: The date it's being held and the instructor are basic ones.

Combining Domains - Augmentations

Q: Can you mix and match NIEM elements into your own Augmentation?

A: Sure can. Your Augmentations can freely mix your own new content with existing NIEM content, regardless of domain (or core)