public interface PrimerPack extends MetadataObject, FixedLengthPack, Cloneable
Represents the local primer pack of header metadata required for the local set encoding of metadata objects. Tag-length-value encoding of an objects properties require the resolution of 2-byte tags to full 16-byte keys. The primer pack is the table that allows for that resolution to take place.
| Modifier and Type | Method and Description |
|---|---|
void |
addLocalTagEntry(LocalTagEntry localTagEntry)
Add a local tag entry to the lookup table that makes up the tag-to-key lookup
table of this primer pack using a local tag entry.
|
void |
addLocalTagEntry(PropertyDefinition propertyDefinition)
Add a local tag entry based on the given property definition,
based on its local identification
and globally unique identification.
|
void |
addLocalTagEntry(short localTag,
AUID uid)
Add a local tag entry to the lookup table that makes up the tag-to-key
lookup table of this primer pack with the 2-byte tag and key.
|
void |
clearLocalTagEntries()
Clear the tag-to-key lookup table of this primer pack.
|
PrimerPack |
clone()
Create a cloned copy of this primer pack.
|
int |
countLocalTagEntries()
Count the number of local tag entries that make up the tag-to-key lookup table of
this primer pack.
|
Set<LocalTagEntry> |
getLocalTagEntryBatch()
Returns the set of local tag entries that make up the tag-to-key lookup table
of this primer pack.
|
boolean |
isLocalTagEntryPresent(LocalTagEntry localTagEntry)
Determines if the given tag is present in this lookup table.
|
Short |
lookupLocalTag(AUID uid)
Lookup the given property identifier and find its local tag in the key-to-tag reverse
lookup table of this primer pack.
|
Short |
lookupLocalTag(PropertyDefinition propertyDefinition)
Lookup the given property's local tag in the key-to-tag reverse lookup table of
this primer pack.
|
AUID |
lookupUID(short localTag)
Lookup the given tag in the tag-to-key lookup table of this primer pack, returning
the given key or
null if the tag is not known. |
getPackOrderSet<LocalTagEntry> getLocalTagEntryBatch()
Returns the set of local tag entries that make up the tag-to-key lookup table of this primer pack.
TypeDefinitions.LocalTagEntryReference,
TypeDefinitions.LocalTagEntryBatchvoid addLocalTagEntry(LocalTagEntry localTagEntry) throws NullPointerException
Add a local tag entry to the lookup table that makes up the tag-to-key lookup table of this primer pack using a local tag entry.
localTagEntry - Local tag entry to add to the lookup table.NullPointerException - Cannot add a null local tag entry.addLocalTagEntry(short, AUID),
addLocalTagEntry(PropertyDefinition)void addLocalTagEntry(@UInt16 short localTag, AUID uid) throws NullPointerException
Add a local tag entry to the lookup table that makes up the tag-to-key lookup table of this primer pack with the 2-byte tag and key.
localTag - Tag to add to the lookup table.uid - Corresponding key to add to the lookup table.NullPointerException - Cannot use a null key.addLocalTagEntry(LocalTagEntry),
addLocalTagEntry(PropertyDefinition)void addLocalTagEntry(PropertyDefinition propertyDefinition) throws NullPointerException
Add a local tag entry based on the given property definition, based on its local identification and globally unique identification. The two identifications add an entry to the tag-to-key lookup table that makes up this primer pack.
propertyDefinition - Property definition to use to create an entry in the tag-to-key
lookup table.NullPointerException - Cannot use a null property definition.addLocalTagEntry(LocalTagEntry),
addLocalTagEntry(short, AUID)int countLocalTagEntries()
Count the number of local tag entries that make up the tag-to-key lookup table of this primer pack.
void clearLocalTagEntries()
Clear the tag-to-key lookup table of this primer pack.
AUID lookupUID(@UInt16 short localTag)
Lookup the given tag in the tag-to-key lookup table of this primer pack, returning
the given key or null if the tag is not known.
localTag - Tag to find and resolve to a key in the lookup table.null if the tag is not
known.Short lookupLocalTag(AUID uid) throws NullPointerException
Lookup the given property identifier and find its local tag in the key-to-tag reverse lookup table of this primer pack.
uid - Identifier to map to a local tag.null if the identifier is not recognized.NullPointerException - Cannot find a tag for a null value.lookupLocalTag(PropertyDefinition)Short lookupLocalTag(PropertyDefinition propertyDefinition) throws NullPointerException
Lookup the given property's local tag in the key-to-tag reverse lookup table of this primer pack.
propertyDefinition - Definition to find the local tag for.null
if the property cannot be found.NullPointerException - Cannot find a tag for a null value.addLocalTagEntry(PropertyDefinition),
lookupLocalTag(AUID)boolean isLocalTagEntryPresent(LocalTagEntry localTagEntry)
Determines if the given tag is present in this lookup table.
localTagEntry - Tag to check for.PrimerPack clone()
Create a cloned copy of this primer pack.
(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.