Class SymbolID2


  • public class SymbolID2
    extends java.lang.Object
    Utility class for helping to parse out parts of the symbol ID. String and Char based interactions vs SymbolID which focuses more on Integer interactions

    • Field Detail

      • Version_2525D

        public static final java.lang.String Version_2525D
        Deprecated.
        2525D(10) will be treated like APP6D(also 10) For 2525D use 2525Dch1(11)
        See Also:
        Constant Field Values
      • Version_2525Dch1

        public static final java.lang.String Version_2525Dch1
        See Also:
        Constant Field Values
      • Version_APP6Dch2

        public static final java.lang.String Version_APP6Dch2
        Deprecated.
        withdrawn from standard
        See Also:
        Constant Field Values
      • Version_2525E

        public static final java.lang.String Version_2525E
        Deprecated.
        use 2525Ech1
        See Also:
        Constant Field Values
      • Version_APP6Ech1

        public static final java.lang.String Version_APP6Ech1
        Deprecated.
        use APP6Ech2
        See Also:
        Constant Field Values
      • Version_2525Ech1

        public static final java.lang.String Version_2525Ech1
        See Also:
        Constant Field Values
      • Version_APP6Ech2

        public static final java.lang.String Version_APP6Ech2
        See Also:
        Constant Field Values
      • StandardIdentity_Context_Reality

        public static final char StandardIdentity_Context_Reality
        See Also:
        Constant Field Values
      • StandardIdentity_Context_Exercise

        public static final char StandardIdentity_Context_Exercise
        See Also:
        Constant Field Values
      • StandardIdentity_Context_Simulation

        public static final char StandardIdentity_Context_Simulation
        See Also:
        Constant Field Values
      • StandardIdentity_Context_Restricted_Target_Reality

        public static final char StandardIdentity_Context_Restricted_Target_Reality
        See Also:
        Constant Field Values
      • StandardIdentity_Context_No_Strike_Entity_Reality

        public static final char StandardIdentity_Context_No_Strike_Entity_Reality
        See Also:
        Constant Field Values
      • StandardIdentity_Affiliation_Pending

        public static final char StandardIdentity_Affiliation_Pending
        See Also:
        Constant Field Values
      • StandardIdentity_Affiliation_Unknown

        public static final char StandardIdentity_Affiliation_Unknown
        See Also:
        Constant Field Values
      • StandardIdentity_Affiliation_AssumedFriend

        public static final char StandardIdentity_Affiliation_AssumedFriend
        See Also:
        Constant Field Values
      • StandardIdentity_Affiliation_Friend

        public static final char StandardIdentity_Affiliation_Friend
        See Also:
        Constant Field Values
      • StandardIdentity_Affiliation_Neutral

        public static final char StandardIdentity_Affiliation_Neutral
        See Also:
        Constant Field Values
      • StandardIdentity_Affiliation_Suspect_Joker

        public static final char StandardIdentity_Affiliation_Suspect_Joker
        See Also:
        Constant Field Values
      • StandardIdentity_Affiliation_Hostile_Faker

        public static final char StandardIdentity_Affiliation_Hostile_Faker
        See Also:
        Constant Field Values
      • SymbolSet_Unknown

        public static final java.lang.String SymbolSet_Unknown
        See Also:
        Constant Field Values
      • SymbolSet_AirMissile

        public static final java.lang.String SymbolSet_AirMissile
        See Also:
        Constant Field Values
      • SymbolSet_SpaceMissile

        public static final java.lang.String SymbolSet_SpaceMissile
        See Also:
        Constant Field Values
      • SymbolSet_LandUnit

        public static final java.lang.String SymbolSet_LandUnit
        See Also:
        Constant Field Values
      • SymbolSet_LandCivilianUnit_Organization

        public static final java.lang.String SymbolSet_LandCivilianUnit_Organization
        See Also:
        Constant Field Values
      • SymbolSet_LandEquipment

        public static final java.lang.String SymbolSet_LandEquipment
        See Also:
        Constant Field Values
      • SymbolSet_LandInstallation

        public static final java.lang.String SymbolSet_LandInstallation
        See Also:
        Constant Field Values
      • SymbolSet_ControlMeasure

        public static final java.lang.String SymbolSet_ControlMeasure
        See Also:
        Constant Field Values
      • SymbolSet_DismountedIndividuals

        public static final java.lang.String SymbolSet_DismountedIndividuals
        See Also:
        Constant Field Values
      • SymbolSet_SeaSurface

        public static final java.lang.String SymbolSet_SeaSurface
        See Also:
        Constant Field Values
      • SymbolSet_SeaSubsurface

        public static final java.lang.String SymbolSet_SeaSubsurface
        See Also:
        Constant Field Values
      • SymbolSet_MineWarfare

        public static final java.lang.String SymbolSet_MineWarfare
        See Also:
        Constant Field Values
      • SymbolSet_Activities

        public static final java.lang.String SymbolSet_Activities
        See Also:
        Constant Field Values
      • SymbolSet_Atmospheric

        public static final java.lang.String SymbolSet_Atmospheric
        See Also:
        Constant Field Values
      • SymbolSet_Oceanographic

        public static final java.lang.String SymbolSet_Oceanographic
        See Also:
        Constant Field Values
      • SymbolSet_MeteorologicalSpace

        public static final java.lang.String SymbolSet_MeteorologicalSpace
        See Also:
        Constant Field Values
      • SymbolSet_SignalsIntelligence

        public static final java.lang.String SymbolSet_SignalsIntelligence
        See Also:
        Constant Field Values
      • SymbolSet_CyberSpace

        public static final java.lang.String SymbolSet_CyberSpace
        See Also:
        Constant Field Values
      • SymbolSet_CyberSpace_Equipment

        public static final java.lang.String SymbolSet_CyberSpace_Equipment
        APP6Ev2 only
        See Also:
        Constant Field Values
      • SymbolSet_InvalidSymbol

        public static final java.lang.String SymbolSet_InvalidSymbol
        See Also:
        Constant Field Values
      • Status_Planned_Anticipated_Suspect

        public static final char Status_Planned_Anticipated_Suspect
        See Also:
        Constant Field Values
      • Status_Present_FullyCapable

        public static final char Status_Present_FullyCapable
        See Also:
        Constant Field Values
      • Status_Present_Damaged

        public static final char Status_Present_Damaged
        See Also:
        Constant Field Values
      • Status_Present_Destroyed

        public static final char Status_Present_Destroyed
        See Also:
        Constant Field Values
      • Status_Present_FullToCapacity

        public static final char Status_Present_FullToCapacity
        See Also:
        Constant Field Values
      • HQTFDU_FeintDummy_Headquarters

        public static final char HQTFDU_FeintDummy_Headquarters
        See Also:
        Constant Field Values
      • HQTFDU_FeintDummy_TaskForce

        public static final char HQTFDU_FeintDummy_TaskForce
        See Also:
        Constant Field Values
      • HQTFDU_TaskForce_Headquarters

        public static final char HQTFDU_TaskForce_Headquarters
        See Also:
        Constant Field Values
      • HQTFDU_FeintDummy_TaskForce_Headquarters

        public static final char HQTFDU_FeintDummy_TaskForce_Headquarters
        See Also:
        Constant Field Values
      • HQTFDU_Unmanned_Marker

        public static final char HQTFDU_Unmanned_Marker
        See Also:
        Constant Field Values
      • HQTFDU_Unmanned_Marker_Autonomous

        public static final char HQTFDU_Unmanned_Marker_Autonomous
        See Also:
        Constant Field Values
      • HQTFDU_Unmanned_Marker_Remotely_Piloted

        public static final char HQTFDU_Unmanned_Marker_Remotely_Piloted
        See Also:
        Constant Field Values
      • HQTFDU_Unmanned_Marker_FeintDummy

        public static final char HQTFDU_Unmanned_Marker_FeintDummy
        See Also:
        Constant Field Values
      • HQTFDU_Unmanned_Marker_Autonomous_FeintDummy

        public static final char HQTFDU_Unmanned_Marker_Autonomous_FeintDummy
        See Also:
        Constant Field Values
      • HQTFDU_Unmanned_Marker_Remotely_Piloted_FeintDummy

        public static final char HQTFDU_Unmanned_Marker_Remotely_Piloted_FeintDummy
        See Also:
        Constant Field Values
      • Echelon_Team_Crew

        public static final java.lang.String Echelon_Team_Crew
        See Also:
        Constant Field Values
      • Echelon_Platoon_Detachment

        public static final java.lang.String Echelon_Platoon_Detachment
        See Also:
        Constant Field Values
      • Echelon_Company_Battery_Troop

        public static final java.lang.String Echelon_Company_Battery_Troop
        See Also:
        Constant Field Values
      • Echelon_Battalion_Squadron

        public static final java.lang.String Echelon_Battalion_Squadron
        See Also:
        Constant Field Values
      • Echelon_Regiment_Group

        public static final java.lang.String Echelon_Regiment_Group
        See Also:
        Constant Field Values
      • Echelon_VersionExtensionFlag

        public static final java.lang.String Echelon_VersionExtensionFlag
        See Also:
        Constant Field Values
      • Echelon_Division

        public static final java.lang.String Echelon_Division
        See Also:
        Constant Field Values
      • Echelon_Corps_MEF

        public static final java.lang.String Echelon_Corps_MEF
        See Also:
        Constant Field Values
      • Echelon_ArmyGroup_Front

        public static final java.lang.String Echelon_ArmyGroup_Front
        See Also:
        Constant Field Values
      • Echelon_Region_Theater

        public static final java.lang.String Echelon_Region_Theater
        See Also:
        Constant Field Values
      • Echelon_Region_Command

        public static final java.lang.String Echelon_Region_Command
        See Also:
        Constant Field Values
      • Echelon_VersionExtensionFlag2

        public static final java.lang.String Echelon_VersionExtensionFlag2
        See Also:
        Constant Field Values
      • Mobility_Unknown

        public static final java.lang.String Mobility_Unknown
        See Also:
        Constant Field Values
      • Mobility_WheeledLimitedCrossCountry

        public static final java.lang.String Mobility_WheeledLimitedCrossCountry
        See Also:
        Constant Field Values
      • Mobility_WheeledCrossCountry

        public static final java.lang.String Mobility_WheeledCrossCountry
        See Also:
        Constant Field Values
      • Mobility_Tracked

        public static final java.lang.String Mobility_Tracked
        See Also:
        Constant Field Values
      • Mobility_Wheeled_Tracked

        public static final java.lang.String Mobility_Wheeled_Tracked
        See Also:
        Constant Field Values
      • Mobility_PackAnimals

        public static final java.lang.String Mobility_PackAnimals
        See Also:
        Constant Field Values
      • Mobility_OverSnow

        public static final java.lang.String Mobility_OverSnow
        See Also:
        Constant Field Values
      • Mobility_Amphibious

        public static final java.lang.String Mobility_Amphibious
        See Also:
        Constant Field Values
      • Mobility_ShortTowedArray

        public static final java.lang.String Mobility_ShortTowedArray
        See Also:
        Constant Field Values
      • Mobility_LongTowedArray

        public static final java.lang.String Mobility_LongTowedArray
        See Also:
        Constant Field Values
      • Leadership_Individual

        public static final java.lang.String Leadership_Individual
        See Also:
        Constant Field Values
      • FrameShape_LandEquipment

        public static final char FrameShape_LandEquipment
        See Also:
        Constant Field Values
      • FrameShape_LandInstallation

        public static final char FrameShape_LandInstallation
        See Also:
        Constant Field Values
      • FrameShape_DismountedIndividuals

        public static final char FrameShape_DismountedIndividuals
        See Also:
        Constant Field Values
      • FrameShape_SeaSubsurface

        public static final char FrameShape_SeaSubsurface
        See Also:
        Constant Field Values
      • FrameShape_Activity_Event

        public static final char FrameShape_Activity_Event
        See Also:
        Constant Field Values
    • Constructor Detail

      • SymbolID2

        public SymbolID2()
    • Method Detail

      • reconcileSymbolID

        public static java.lang.String reconcileSymbolID​(java.lang.String symbolID)
        Attempts to resolve a bad symbol ID into a value that can be found in MSLookup. If it fails, it will return the symbol code for a invalid symbol which is displayed as an inverted question mark (110098000010000000000000000000)
        Parameters:
        symbolID - 30 character String
        Returns:
        30 character String representing the resolved symbol ID.
      • getVersion

        public static java.lang.String getVersion​(java.lang.String symbolID)
        Gets the version number from the Symbol ID at positions 1-2
        Parameters:
        symbolID - 30 character String
        Returns:
        String like Version_2525Dch1 (11)

      • setVersion

        public static java.lang.String setVersion​(java.lang.String symbolID,
                                                  java.lang.String ver)
        Sets the version number of the Symbol ID at positions 1-2
        Parameters:
        symbolID - 30 character String
        ver - String like Version_2525Dch1 (11)
        Returns:
        updated 30 character String symbol ID
      • getContext

        public static char getContext​(java.lang.String symbolID)
        Get Context (Reality (0), Exercise (1), Simulation (2)) at position 3 Higher values are NATO only
        Parameters:
        symbolID - 30 Character String
        Returns:
        Character

      • setContext

        public static java.lang.String setContext​(java.lang.String symbolID,
                                                  char context)
        Set Context (Reality (0), Exercise (1), Simulation (2)) at position 3
        Parameters:
        symbolID - 30 Character String
        context - Character
        Returns:
        String updated Symbol ID.
      • getAffiliation

        public static char getAffiliation​(java.lang.String symbolID)
        Get Affiliation from position 4
        Parameters:
        symbolID - 30 Character String
        Returns:
        Character like StandardIdentity_Affiliation_Friend

      • setAffiliation

        public static java.lang.String setAffiliation​(java.lang.String symbolID,
                                                      char affiliation)
        Set Affiliation at position 4
        Parameters:
        symbolID - 30 Character String
        affiliation - like StandardIdentity_Affiliation_Friend
        Returns:
        String updated Symbol ID.
      • getSymbolSet

        public static java.lang.String getSymbolSet​(java.lang.String symbolID)
        Get Symbol Set from positions 5-6
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer like SymbolSet_LandCivilianUnit_Organization

      • setSymbolSet

        public static java.lang.String setSymbolSet​(java.lang.String symbolID,
                                                    java.lang.String ss)
        Set Symbol Set at positions 5-6
        Parameters:
        symbolID - 30 Character String
        ss - like SymbolSet_LandCivilianUnit_Organization
        Returns:
        String updated Symbol ID.
      • getStatus

        public static int getStatus​(java.lang.String symbolID)
        Get Status from position 7
        Parameters:
        symbolID - 30 Character String
        Returns:
        Character like Status_Present

      • setStatus

        public static java.lang.String setStatus​(java.lang.String symbolID,
                                                 char status)
        Set Status at position 7
        Parameters:
        symbolID - 30 Character String
        status - like Status_Present
        Returns:
        String updated Symbol ID.
      • getHQTFDU

        public static char getHQTFDU​(java.lang.String symbolID)
        Get HQTFDU from position 8
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer like HQTFDU_Headquarters

      • setHQTFDU

        public static java.lang.String setHQTFDU​(java.lang.String symbolID,
                                                 char hqtfdu)
        Set HQTFDU at position 8
        Parameters:
        symbolID - 30 Character String
        hqtfdu - like HQTFDU_Headquarters
        Returns:
        String updated Symbol ID.
      • getAmplifierDescriptor

        public static java.lang.String getAmplifierDescriptor​(java.lang.String symbolID)
        Get Amplifier Descriptor which can describe things like Echelon / Mobility / Towed Array / Leadership Indicator from positions 9-10
        Parameters:
        symbolID - 30 Character String
        Returns:
        String

      • setAmplifierDescriptor

        public static java.lang.String setAmplifierDescriptor​(java.lang.String symbolID,
                                                              java.lang.String ad)
        Set Amplifier Descriptor which can describe things like Echelon / Mobility / Towed Array / Leadership Indicator at positions 9-10
        Parameters:
        symbolID - 30 Character String
        ad - String
        Returns:
        String
      • getEntityCode

        public static java.lang.String getEntityCode​(java.lang.String symbolID)
        Get Entity Code from positions 11-16. These six digits identify a unique symbol within a symbol set.
        Parameters:
        symbolID - 30 Character String
        Returns:
        String

      • setEntityCode

        public static java.lang.String setEntityCode​(java.lang.String symbolID,
                                                     java.lang.String entityCode)
        Set Entity Code at positions 11-16. These six digits identify a unique symbol within a symbol set.
        Parameters:
        symbolID - 30 Character String
        entityCode - String
        Returns:
        String
      • getEntity

        public static java.lang.String getEntity​(java.lang.String symbolID)
        Get Entity from positions 11-12.
        Parameters:
        symbolID - 30 Character String
        Returns:
        String
      • getEntityType

        public static java.lang.String getEntityType​(java.lang.String symbolID)
        Get Entity Type from positions 13-14.
        Parameters:
        symbolID - 30 Character String
        Returns:
        String
      • getEntitySubtype

        public static java.lang.String getEntitySubtype​(java.lang.String symbolID)
        Get Entity Subtype from positions 15-16.
        Parameters:
        symbolID - 30 Character String
        Returns:
        String
      • getModifier1

        public static java.lang.String getModifier1​(java.lang.String symbolID)
        Get Sector 1 Modifier from positions 17-18.
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer

      • setModifier1

        public static java.lang.String setModifier1​(java.lang.String symbolID,
                                                    java.lang.String mod1)
        Set Sector 1 Modifier to positions 17-18.
        Parameters:
        symbolID - 30 Character String
        mod1 - String hex string from "00" to "FF"
        Returns:
        String
      • getCommonModifier1

        public static char getCommonModifier1​(java.lang.String symbolID)
        Get Common Sector 1 Modifier from position 21.
        Parameters:
        symbolID - 30 Character String
        Returns:
        String
      • setCommonModifier1

        public static java.lang.String setCommonModifier1​(java.lang.String symbolID,
                                                          char mod1I)
        Set Common Sector 1 Modifier at position 21.
        Parameters:
        symbolID - 30 Character String
        mod1I - Character
        Returns:
        String
      • getModifier2

        public static java.lang.String getModifier2​(java.lang.String symbolID)
        Get Sector 2 Modifier from positions 17-18.
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer

      • setModifier2

        public static java.lang.String setModifier2​(java.lang.String symbolID,
                                                    java.lang.String mod2)
        Set Sector 2 Modifier to positions 17-18.
        Parameters:
        symbolID - 30 Character String
        mod2 - String hex string from "00" to "FF"
        Returns:
        String
      • getCommonModifier2

        public static char getCommonModifier2​(java.lang.String symbolID)
        Get Common Sector 2 Modifier from position 22.
        Parameters:
        symbolID - 30 Character String
        Returns:
        Integer
      • setCommonModifier2

        public static java.lang.String setCommonModifier2​(java.lang.String symbolID,
                                                          char mod2I)
        Set Common Sector 2 Modifier at position 22.
        Parameters:
        symbolID - 30 Character String
        mod2I - Integer
        Returns:
        String
      • getFrameID

        public static java.lang.String getFrameID​(java.lang.String symbolID)
        Deprecated.
        See SVGLookup.getFrameID(String)
        Build string to grab appropriate SVG file
        Parameters:
        symbolID - 30 Character String
        Returns:
        String
      • getMainIconID

        public static java.lang.String getMainIconID​(java.lang.String symbolID)
        Deprecated.
        See SVGLookup.getMainIconID(String)
        Build string to grab appropriate SVG file
        Parameters:
        symbolID - 30 Character String
        Returns:
        String
      • getMod2ID

        public static java.lang.String getMod2ID​(java.lang.String symbolID)
        Deprecated.
        See SVGLookup.getMod2ID(String) (String)}
        Build string to grab appropriate SVG file
        Parameters:
        symbolID - 30 Character String
        Returns:
        String
      • getMod1ID

        public static java.lang.String getMod1ID​(java.lang.String symbolID)
        Deprecated.
        See SVGLookup.getMod1ID(String) (String)}
        Build string to grab appropriate SVG file
        Parameters:
        symbolID - 30 Character String
        Returns:
        String
      • getCountryCode

        public static java.lang.String getCountryCode​(java.lang.String symbolID)
        Gets the 3 digit county code from positions 28-30
        Parameters:
        symbolID - 30 Character String
        Returns:
        String
      • setCountryCode

        public static java.lang.String setCountryCode​(java.lang.String symbolID,
                                                      java.lang.String countryCode)
        Sets the country code on the symbol code
        Parameters:
        symbolID - 30 Character string
        countryCode - country code like "840" for USA or "076" for Brazil
        Returns:
        updated 30 character symbolID
      • getDefaultFrameShape

        public static char getDefaultFrameShape​(java.lang.String symbolID)
        In 2525E, position 23 of the symbol code has the Frame Shape modifier. This lets a user force a different frame shape than what a symbol would normally have. Like you could have Air Fixed Wing with a ground unit rectangle frame for when it's on the ground. This function returns the frame shape value for what the default frame would be for a specific symbol set.
        Parameters:
        symbolID - 30 Character String
        Returns:
        Character

      • setFrameShape

        public static java.lang.String setFrameShape​(java.lang.String symbolID,
                                                     char frameShape)
        Parameters:
        symbolID - 30 character symbol ID
        frameShape - like SymbolID.FrameShape_LandEquipment
        Returns:
        updated 30 character symbolID
      • getFrameShape

        public static char getFrameShape​(java.lang.String symbolID)
        Gets the Frame Shape override from position 23.
        Parameters:
        symbolID - 30 Character String
        Returns:
        Character