com.luciad.format.nitf

Defense StandardsClass TLcdNITFTextSegment

java.lang.Object

com.luciad.format.nitf.TLcdNITFTextSegment

public final class TLcdNITFTextSegment
extends Object

This class represents a text segment from an NITF file See MIL-STD-2500c, Table A-6

Since:

2013.1

Method Summary

Modifier and Type	Method and Description
String	getAttachmentLevel() Text Attachment Level.
String	getClassificationAuthority() Text Classification Authority.
String	getClassificationAuthorityType() Text Classification Authority Type.
String	getClassificationReason() Text Classification Reason.
String	getClassificationText() Text Classification Text.
String	getCodewords() Text Codewords.
String	getControlAndHandling() Text Control and Handling.
String	getDateAndTime() Text Date and Time.
String	getDeclassificationDate() Text Declassification Date.
String	getDeclassificationExemption() Text Declassification Exemption.
String	getDeclassificationType() Text Declassification Type.
String	getDowngrade() Text Downgrade.
String	getDowngradeDate() Text Downgrade Date.
String	getEncryption() Encryption.
String	getFilePartType() File Part Type.
String	getFormat() Text Format.
String	getId() Text Identifier.
String	getReleasingInstructions() Text Releasing Instructions.
String	getSecurityClassification() Text Security Classification.
String	getSecurityClassificationSystem() Text Security Classification System.
String	getSecurityControlNumber() Text Security Control Number.
String	getSecuritySourceDate() Text Security Source Date.
String	getText() The text segment text.
String	getTitle() Text Title.
void	setAttachmentLevel(String aAttachmentLevel) Text Attachment Level.
void	setClassificationAuthority(String aClassificationAuthority) Text Classification Authority.
void	setClassificationAuthorityType(String aClassificationAuthorityType) Text Classification Authority Type.
void	setClassificationReason(String aClassificationReason) Text Classification Reason.
void	setClassificationText(String aClassificationText) Text Classification Text.
void	setCodewords(String aCodewords) Text Codewords.
void	setControlAndHandling(String aControlAndHandling) Text Control and Handling.
void	setDateAndTime(String aDateAndTime) Text Date and Time.
void	setDeclassificationDate(String aDeclassificationDate) Text Declassification Date.
void	setDeclassificationExemption(String aDeclassificationExemption) Text Declassification Exemption.
void	setDeclassificationType(String aDeclassificationType) Text Declassification Type.
void	setDowngrade(String aDowngrade) Text Downgrade.
void	setDowngradeDate(String aDowngradeDate) Text Downgrade Date.
void	setEncryption(String aEncryption) Encryption.
void	setFilePartType(String aFilePartType) File Part Type.
void	setFormat(String aFormat) Text Format.
void	setId(String aId) Text Identifier.
void	setReleasingInstructions(String aReleasingInstructions) Text Releasing Instructions.
void	setSecurityClassification(String aSecurityClassification) Text Security Classification.
void	setSecurityClassificationSystem(String aSecurityClassificationSystem) Text Security Classification System.
void	setSecurityControlNumber(String aSecurityControlNumber) Text Security Control Number.
void	setSecuritySourceDate(String aSecuritySourceDate) Text Security Source Date.
void	setText(String aText) The text segment text.
void	setTitle(String aTitle) Text Title.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getFilePartType

public String getFilePartType()

File Part Type. This field shall contain the characters "TE" to identify the subheader as a text subheader.

Returns:

the file part type

setFilePartType

public void setFilePartType(String aFilePartType)

File Part Type. This field shall contain the characters "TE" to identify the subheader as a text subheader.

Parameters:

aFilePartType - the file part type

getId

public String getId()

Text Identifier. This field shall contain a valid alphanumeric identification code associated with the text item. The valid codes are determined by the application.

Returns:

the id

setId

public void setId(String aId)

Text Identifier. This field shall contain a valid alphanumeric identification code associated with the text item. The valid codes are determined by the application.

Parameters:

aId - the id

getAttachmentLevel

public String getAttachmentLevel()

Text Attachment Level. This field shall contain a valid value that indicates the attachment level of the text. Valid values for this field are 000 (BCS zeros (0x30)) or the display level value of any image or graphic in the file.

Returns:

the attachment level

setAttachmentLevel

public void setAttachmentLevel(String aAttachmentLevel)

Text Attachment Level. This field shall contain a valid value that indicates the attachment level of the text. Valid values for this field are 000 (BCS zeros (0x30)) or the display level value of any image or graphic in the file.

Parameters:

aAttachmentLevel - the attachment level

getDateAndTime

public String getDateAndTime()

Text Date and Time. This field shall contain the time (UTC) (Zulu) of origination of the text in the format CCYYMMDDhhmmss, where CC is the century (00 to 99), YY is the last two digits of the year (00 to 99), MM is the month (01 to 12), DD is the day (01 to 31), hh is the hour (00 to 23), mm is the minute (00 to 59), and ss is the second (00 to 59). UTC (Zulu) is assumed to be the time zone designator to express the time of day. Refer to Paragraph 53.1.7d when a portion of the date and/or time is unknown.

Returns:

the date and time

setDateAndTime

public void setDateAndTime(String aDateAndTime)

Text Date and Time. This field shall contain the time (UTC) (Zulu) of origination of the text in the format CCYYMMDDhhmmss, where CC is the century (00 to 99), YY is the last two digits of the year (00 to 99), MM is the month (01 to 12), DD is the day (01 to 31), hh is the hour (00 to 23), mm is the minute (00 to 59), and ss is the second (00 to 59). UTC (Zulu) is assumed to be the time zone designator to express the time of day. Refer to Paragraph 53.1.7d when a portion of the date and/or time is unknown.

Parameters:

aDateAndTime - the date and time

getTitle

public String getTitle()

Text Title. This field shall contain the title of the text item.

Returns:

the title

setTitle

public void setTitle(String aTitle)

Text Title. This field shall contain the title of the text item.

Parameters:

aTitle - the title

getSecurityClassification

public String getSecurityClassification()

Text Security Classification. This field shall contain a valid value representing the classification level of the text. Valid values are T (=Top Secret), S (=Secret), C (=Confidential), R (=Restricted), U (=Unclassified).

Returns:

the security classification

setSecurityClassification

public void setSecurityClassification(String aSecurityClassification)

Text Security Classification. This field shall contain a valid value representing the classification level of the text. Valid values are T (=Top Secret), S (=Secret), C (=Confidential), R (=Restricted), U (=Unclassified).

Parameters:

aSecurityClassification - the security classification

getSecurityClassificationSystem

public String getSecurityClassificationSystem()

Text Security Classification System. This field shall contain valid values indicating the national or multinational security system used to classify the text. Country Codes per FIPS PUB 10-4 shall be used to indicate national security systems. The designator "XN" is for classified data generated by a component using NATO security system marking guidance. This code is outside the FIPS 10-4 document listing, and was selected to not duplicate that document's existing codes. If this field is all ECS spaces (0x20), it shall imply that no security classification system applies to the text.

Returns:

the security classification system

setSecurityClassificationSystem

public void setSecurityClassificationSystem(String aSecurityClassificationSystem)

Text Security Classification System. This field shall contain valid values indicating the national or multinational security system used to classify the text. Country Codes per FIPS PUB 10-4 shall be used to indicate national security systems. The designator "XN" is for classified data generated by a component using NATO security system marking guidance. This code is outside the FIPS 10-4 document listing, and was selected to not duplicate that document's existing codes. If this field is all ECS spaces (0x20), it shall imply that no security classification system applies to the text.

Parameters:

aSecurityClassificationSystem - the security classification system

getCodewords

public String getCodewords()

Text Codewords. This field shall contain a valid indicator of the security compartments associated with the text. Values include one or more of the digraphs found in table A-4. Multiple entries shall be separated by a single ECS spaces (0x20): The selection of a relevant set of codewords is application specific. If this field is all ECS spaces (0x20), it shall imply that no codewords apply to the text.

Returns:

the codewords

setCodewords

public void setCodewords(String aCodewords)

Text Codewords. This field shall contain a valid indicator of the security compartments associated with the text. Values include one or more of the digraphs found in table A-4. Multiple entries shall be separated by a single ECS spaces (0x20): The selection of a relevant set of codewords is application specific. If this field is all ECS spaces (0x20), it shall imply that no codewords apply to the text.

Parameters:

aCodewords - the codewords

getControlAndHandling

public String getControlAndHandling()

Text Control and Handling. This field shall contain valid additional security control and/or handling instructions (caveats) associated with the text. Values include digraphs found in table A-4. The digraph may indicate single or multiple caveats. The selection of a relevant caveat(s) is application specific. If this field is all ECS spaces (0x20), it shall imply that no additional control and handling instructions apply to the text.

Returns:

the control and handling

setControlAndHandling

public void setControlAndHandling(String aControlAndHandling)

Text Control and Handling. This field shall contain valid additional security control and/or handling instructions (caveats) associated with the text. Values include digraphs found in table A-4. The digraph may indicate single or multiple caveats. The selection of a relevant caveat(s) is application specific. If this field is all ECS spaces (0x20), it shall imply that no additional control and handling instructions apply to the text.

Parameters:

aControlAndHandling - the control and handling

getReleasingInstructions

public String getReleasingInstructions()

Text Releasing Instructions. This field shall contain a valid list of country and/or multilateral entity codes to which countries and/or multilateral entities the text is authorized for release. Valid items in the list are one or more country codes as found in FIPS PUB 10-4 and/or codes identifying multilateral entities. If this field is all ECS spaces (0x20), it shall imply that no text release instructions apply.

Returns:

the releasing instructions

setReleasingInstructions

public void setReleasingInstructions(String aReleasingInstructions)

Text Releasing Instructions. This field shall contain a valid list of country and/or multilateral entity codes to which countries and/or multilateral entities the text is authorized for release. Valid items in the list are one or more country codes as found in FIPS PUB 10-4 and/or codes identifying multilateral entities. If this field is all ECS spaces (0x20), it shall imply that no text release instructions apply.

Parameters:

aReleasingInstructions - the releasing instructions

getDeclassificationType

public String getDeclassificationType()

Text Declassification Type. This field shall contain a valid indicator of the type of security declassification or downgrading instructions which apply to the text. Valid values are DD (=declassify on a specific date), DE (=declassify upon occurrence of an event), GD (=downgrade to a specified level on a specific date), GE (=downgrade to a specified level upon occurrence of an event), O (=OADR), and X (= exempt from automatic declassification). If this field is all ECS spaces (0x20), it shall imply that no text security declassification or downgrading instructions apply.

Returns:

the declassification type

setDeclassificationType

public void setDeclassificationType(String aDeclassificationType)

Text Declassification Type. This field shall contain a valid indicator of the type of security declassification or downgrading instructions which apply to the text. Valid values are DD (=declassify on a specific date), DE (=declassify upon occurrence of an event), GD (=downgrade to a specified level on a specific date), GE (=downgrade to a specified level upon occurrence of an event), O (=OADR), and X (= exempt from automatic declassification). If this field is all ECS spaces (0x20), it shall imply that no text security declassification or downgrading instructions apply.

Parameters:

aDeclassificationType - the declassification type

getDeclassificationDate

public String getDeclassificationDate()

Text Declassification Date. This field shall indicate the date on which a text is to be declassified if the value in Text Declassification Type is DD. If this field is all ECS spaces (0x20), it shall imply that no text declassification date applies.

Returns:

the declassification date

setDeclassificationDate

public void setDeclassificationDate(String aDeclassificationDate)

Text Declassification Date. This field shall indicate the date on which a text is to be declassified if the value in Text Declassification Type is DD. If this field is all ECS spaces (0x20), it shall imply that no text declassification date applies.

Parameters:

aDeclassificationDate - the declassification date

getDeclassificationExemption

public String getDeclassificationExemption()

Text Declassification Exemption. This field shall indicate the reason the text is exempt from automatic declassification if the value in Text Declassification Type is X. Valid values are X1 to X8 and X251 to X259. X1 to X8 correspond to the declassification exemptions found in DOD 5200.1-R, paragraphs 4- 202b(1) to (8) for material exempt from the 10-year rule. X251 to X259 correspond to the declassification exemptions found in DOD 5200.1-R, paragraphs 4- 301a(1) to (9) for permanently valuable material exempt from the 25-year declassification system. If this field is all ECS spaces (0x20), it shall imply that a text declassification exemption does not apply.

Returns:

the declassification exemption

setDeclassificationExemption

public void setDeclassificationExemption(String aDeclassificationExemption)

Text Declassification Exemption. This field shall indicate the reason the text is exempt from automatic declassification if the value in Text Declassification Type is X. Valid values are X1 to X8 and X251 to X259. X1 to X8 correspond to the declassification exemptions found in DOD 5200.1-R, paragraphs 4- 202b(1) to (8) for material exempt from the 10-year rule. X251 to X259 correspond to the declassification exemptions found in DOD 5200.1-R, paragraphs 4- 301a(1) to (9) for permanently valuable material exempt from the 25-year declassification system. If this field is all ECS spaces (0x20), it shall imply that a text declassification exemption does not apply.

Parameters:

aDeclassificationExemption - the declassification exemption

getDowngrade

public String getDowngrade()

Text Downgrade. This field shall indicate the classification level to which a text is to be downgraded if the values in Text Declassification Type are GD or GE. Valid values are S (=Secret), C (=Confidential), R (= Restricted). If this field contains an ECS space (0x20), it shall imply that text security downgrading does not apply.

Returns:

the downgrade

setDowngrade

public void setDowngrade(String aDowngrade)

Text Downgrade. This field shall indicate the classification level to which a text is to be downgraded if the values in Text Declassification Type are GD or GE. Valid values are S (=Secret), C (=Confidential), R (= Restricted). If this field contains an ECS space (0x20), it shall imply that text security downgrading does not apply.

Parameters:

aDowngrade - the downgrade

getDowngradeDate

public String getDowngradeDate()

Text Downgrade Date. This field shall indicate the date on which a text is to be downgraded if the value in Text Declassification Type is GD. If this field is all ECS spaces (0x20), it shall imply that a text security downgrading date does not apply.

Returns:

the downgrade date

setDowngradeDate

public void setDowngradeDate(String aDowngradeDate)

Text Downgrade Date. This field shall indicate the date on which a text is to be downgraded if the value in Text Declassification Type is GD. If this field is all ECS spaces (0x20), it shall imply that a text security downgrading date does not apply.

Parameters:

aDowngradeDate - the downgrade date

getClassificationText

public String getClassificationText()

Text Classification Text. This field shall be used to provide additional information about text classification to include identification of a declassification or downgrading event if the values in Text Declassification Type are DE or GE.. It may also be used to identify multiple classification sources and/or any other special handling rules. Values are user defined free text. If this field is all ECS spaces (0x20), it shall imply that additional information about text classification does not apply.

Returns:

the classification text

setClassificationText

public void setClassificationText(String aClassificationText)

Text Classification Text. This field shall be used to provide additional information about text classification to include identification of a declassification or downgrading event if the values in Text Declassification Type are DE or GE.. It may also be used to identify multiple classification sources and/or any other special handling rules. Values are user defined free text. If this field is all ECS spaces (0x20), it shall imply that additional information about text classification does not apply.

Parameters:

aClassificationText - the classification text

getClassificationAuthorityType

public String getClassificationAuthorityType()

Text Classification Authority Type. This field shall indicate the type of authority used to classify the text. Valid values are O (= original classification authority), D (= derivative from a single source), and M (= derivative from multiple sources). If this field contains an ECS space (0x20), it shall imply that text classification authority type does not apply.

Returns:

the classification authority type

setClassificationAuthorityType

public void setClassificationAuthorityType(String aClassificationAuthorityType)

Text Classification Authority Type. This field shall indicate the type of authority used to classify the text. Valid values are O (= original classification authority), D (= derivative from a single source), and M (= derivative from multiple sources). If this field contains an ECS space (0x20), it shall imply that text classification authority type does not apply.

Parameters:

aClassificationAuthorityType - the classification authority type

getClassificationAuthority

public String getClassificationAuthority()

Text Classification Authority. This field shall identify the classification authority for the text dependent upon the value in Text Classification Authority Type. Values are user defined free text which should contain the following information: original classification authority name and position or personal identifier if the value in Text Classification Authority Type is O; title of the document or security classification guide used to classify the text if the value in Text Classification Authority Type is D; and Derive-Multiple if the text classification was derived from multiple sources. In the latter case, the text originator will maintain a record of the sources used in accordance with existing security directives. One of the multiple sources may also be identified in Text Classification Text if desired. If this field is all ECS spaces (0x20), it shall imply that no text classification authority applies.

Returns:

the classification authority

setClassificationAuthority

public void setClassificationAuthority(String aClassificationAuthority)

Text Classification Authority. This field shall identify the classification authority for the text dependent upon the value in Text Classification Authority Type. Values are user defined free text which should contain the following information: original classification authority name and position or personal identifier if the value in Text Classification Authority Type is O; title of the document or security classification guide used to classify the text if the value in Text Classification Authority Type is D; and Derive-Multiple if the text classification was derived from multiple sources. In the latter case, the text originator will maintain a record of the sources used in accordance with existing security directives. One of the multiple sources may also be identified in Text Classification Text if desired. If this field is all ECS spaces (0x20), it shall imply that no text classification authority applies.

Parameters:

aClassificationAuthority - the classification authority

getClassificationReason

public String getClassificationReason()

Text Classification Reason. This field shall contain values indicating the reason for classifying the text. Valid values are A to G. These correspond to the reasons for original classification per E.O. 12958, Section 1.5.(a) to (g). If this field contains an ECS space (0x20), it shall imply that no text classification reason applies.

Returns:

the classification reason

setClassificationReason

public void setClassificationReason(String aClassificationReason)

Text Classification Reason. This field shall contain values indicating the reason for classifying the text. Valid values are A to G. These correspond to the reasons for original classification per E.O. 12958, Section 1.5.(a) to (g). If this field contains an ECS space (0x20), it shall imply that no text classification reason applies.

Parameters:

aClassificationReason - the classification reason

getSecuritySourceDate

public String getSecuritySourceDate()

Text Security Source Date. This field shall indicate the date of the source used to derive the classification of the text. In the case of multiple sources, the date of the most recent source shall be used. If this field is all ECS spaces (0x20), it shall imply that a text security source date does not apply.

Returns:

the security source date

setSecuritySourceDate

public void setSecuritySourceDate(String aSecuritySourceDate)

Text Security Source Date. This field shall indicate the date of the source used to derive the classification of the text. In the case of multiple sources, the date of the most recent source shall be used. If this field is all ECS spaces (0x20), it shall imply that a text security source date does not apply.

Parameters:

aSecuritySourceDate - the security source date

getSecurityControlNumber

public String getSecurityControlNumber()

Text Security Control Number. This field shall contain a valid security control number associated with the text. The format of the security control number shall be in accordance with the regulations governing the appropriate security channel(s). If this field is all ECS spaces (0x20), it shall imply that no text security control number applies.

Returns:

the security control number

setSecurityControlNumber

public void setSecurityControlNumber(String aSecurityControlNumber)

Text Security Control Number. This field shall contain a valid security control number associated with the text. The format of the security control number shall be in accordance with the regulations governing the appropriate security channel(s). If this field is all ECS spaces (0x20), it shall imply that no text security control number applies.

Parameters:

aSecurityControlNumber - the security control number

getEncryption

public String getEncryption()

Encryption. This field shall contain the value BCS zero (0x30) until such time as this specification is updated to define the use of other values.

Returns:

the encryption

setEncryption

public void setEncryption(String aEncryption)

Encryption. This field shall contain the value BCS zero (0x30) until such time as this specification is updated to define the use of other values.

Parameters:

aEncryption - the encryption

getFormat

public String getFormat()

Text Format. This field shall contain a valid three- character code indicating the format or type of text data. Valid codes are MTF to indicate USMTF (Refer to MIL-STD-6040 for examples of the USMTF format), STA to indicate BCS, UT1 to indicate ECS text formatting, and U8S to indicate U8S text formatting. Refer to paragraph 5.7.1 for additional discussion of standards and the BCS.

Returns:

the format

setFormat

public void setFormat(String aFormat)

Text Format. This field shall contain a valid three- character code indicating the format or type of text data. Valid codes are MTF to indicate USMTF (Refer to MIL-STD-6040 for examples of the USMTF format), STA to indicate BCS, UT1 to indicate ECS text formatting, and U8S to indicate U8S text formatting. Refer to paragraph 5.7.1 for additional discussion of standards and the BCS.

Parameters:

aFormat - the format

getText

public String getText()

The text segment text.

Returns:

the text

setText

public void setText(String aText)

The text segment text.

Parameters:

aText - the text