T
- The class type implementationpublic abstract class AMetadata<T> extends Object
Metadata fields are defined in the SSRF XSD as the "metadata" attribute group. These attributes apply to all data items, to all leaf elements wihthout sub-elements (but with content), and to the Common element. All SSRF field types extend this abstract class to support these optional metadata fields.
Example: (Dummy classification for demonstration only). In this case, the power value is Unclassified, but the associated remarks (index 12) is Confidential releasable to three nations only.
<Transmitter cls="C"> <Serial cls="U">USA::TX:2011-00001</Serial> <ExtReferenceRef cls="U" idx="1">USA::EX:12</ExtReferenceRef> <ExtReferenceRef cls="U" idx="2">FRA::EX:34</ExtReferenceRef> <Remarks cls="U" idx="1">This is a JTIDS Class 2H terminal</Remarks> <...Ten Other Remarks...> <Remarks cls="C" release="USA GBR CAN" idx="12">All modes are limited to 200W</Remarks> <Other_Transmitter_Elements/> <Power cls="U" extReferences="1 2" remarksarkReferences="1 12">23</Power> </Transmitter>
This abstract class is extended by classes in the SSRF metadata attribute group.
Developer note: This abstract class is not part of the SSRF specification and therefore must be annotated as XmlTransient to successfully marshal SSRF instances.
Modifier and Type | Field and Description |
---|---|
protected String |
availability
US:availability - data supporting legacy equipment certification business
practice.
|
protected ListCCL |
cls
cls - Classification (Required)
|
protected Set<BigInteger> |
extReferences
extReferences - Links to External References (Optional)
|
protected String |
idref
idref - Data Item ID (Optional)
|
protected String |
legacyReleasability
US:legacyReleasability - Legacy Releasability (Optional)
|
protected String |
quality
US:quality - Data Quality (Optional)
|
protected String |
recommendedValue
US:recommendedValue - Recommended Value (Optional)
|
protected Set<BigInteger> |
remarkRef
remark References - Links to Data Item Remarks (Optional)
|
Constructor and Description |
---|
AMetadata()
Metadata types require a zero argument constructor.
|
Modifier and Type | Method and Description |
---|---|
String |
getAvailability()
Get In attribute availability (US), enter data supporting legacy equipment
certification business practice of entering "Unknown", "N/A", "Not
Available" or "Not Applicable", when data is not available.
|
ListCCL |
getCls()
Get the classification of the current data item.
|
Set<BigInteger> |
getExtReferences()
Get a list of Common/ExtReferenceRef idx values applicable to the current
data item.
|
String |
getIdref()
Get a unique identifier for each Data Item in the Dataset.
|
String |
getLegacyReleasability()
Get one or more special handling instructions in sentence format, not code
format.
|
String |
getQuality()
Get one or more data quality indicator(s), separated by "|” (i.e., ASCII
character #124), for the contents of the associated Data Item For example,
"Outlier" | "Non-CodeList".
|
String |
getRecommendedValue()
Get a value that is most probably correct.
|
Set<BigInteger> |
getRemarkRef()
Get a list of Common/Remarks idx values applicable to the current data
item.
|
boolean |
isSet()
Determine if the required fields in this SSRF data type instance are set.
|
boolean |
isSetAvailability()
Determine if the Availability is configured.
|
boolean |
isSetCls()
Determine if the Cls is configured.
|
boolean |
isSetExtReferences()
Determine if the ExtReferences is configured.
|
boolean |
isSetIdref()
Determine if the Idref is configured.
|
boolean |
isSetLegacyReleasability()
Determine if the LegacyReleasability is configured.
|
boolean |
isSetQuality()
Determine if the Quality is configured.
|
boolean |
isSetRecommendedValue()
Determine if the RecommendedValue is configured.
|
boolean |
isSetRemarkRef()
Get a list of Common/Remarks idx values applicable to the current data
item.
|
void |
setAvailability(String value)
Set In attribute availability (US), enter data supporting legacy equipment
certification business practice of entering "Unknown", "N/A", "Not
Available" or "Not Applicable", when data is not available.
|
void |
setCls(ListCCL value)
Set the classification of the current data item.
|
void |
setIdref(String value)
Set a unique identifier for each Data Item in the Dataset.
|
void |
setLegacyReleasability(String value)
Set one or more special handling instructions in sentence format, not code
format.
|
void |
setQuality(String value)
Set one or more data quality indicator(s), separated by "|” (i.e., ASCII
character #124), for the contents of the associated Data Item For example,
"Outlier" | "Non-CodeList".
|
void |
setRecommendedValue(String value)
Set a value that is most probably correct.
|
String |
toString()
Get a string representation of this Common instance configuration.
|
void |
unsetExtReferences()
Clear the ExtReferences field.
|
void |
unsetRemarkRef()
Clear the RemarkIndex field.
|
T |
withAvailability(ListAvailability value)
Set the availability (US) data supporting legacy equipment certification
business practice of entering "Unknown", "N/A", "Not Available" or "Not
Applicable", when data is not available.
|
T |
withCls(ListCCL value)
Set the classification of the current data item.
|
T |
withExtReferences(BigInteger... values)
Set a list of Common/ExtReferenceRef idx values applicable to the current
data item.
|
T |
withExtReferences(Set<BigInteger> values)
Set a list of Common/ExtReferenceRef idx values applicable to the current
data item.
|
T |
withIdref(String value)
Set a unique identifier for each Data Item in the Dataset.
|
T |
withLegacyReleasability(String value)
Set one or more special handling instructions in sentence format, not code
format.
|
T |
withQuality(String value)
Set one or more data quality indicator(s), separated by "|” (i.e., ASCII
character #124), for the contents of the associated Data Item For example,
"Outlier" | "Non-CodeList".
|
T |
withRecommendedValue(String value)
Set a value that is most probably correct.
|
T |
withRemarkRef(BigInteger... values)
Set a list of Common/Remarks idx values applicable to the current data
item.
|
T |
withRemarkRef(Set<BigInteger> values)
Set a list of Common/Remarks idx values applicable to the current data
item.
|
protected ListCCL cls
The classification of the current data item. This attribute is REQUIRED on each data item, even if the classification is "U".
Format is L:CCL
protected Set<BigInteger> remarkRef
A list of Common/Remarks idx values applicable to the current data item.
Format is List of UN6
protected Set<BigInteger> extReferences
A list of Common/ExtReferenceRef idx values applicable to the current data item.
Format is List of UN6
protected String legacyReleasability
One or more special handling instructions in sentence format, not code format. For example, "Approved for public release; distribution is unlimited". Multiple special handling instructions are separated by "|” (i.e., ASCII character #124).
Format is Memo
protected String quality
One or more data quality indicator(s), separated by "|” (i.e., ASCII character #124), for the contents of the associated Data Item For example, "Outlier" | "Non-CodeList".
Format is S255
protected String recommendedValue
A value that is most probably correct.
Format is Memo
protected String idref
A unique identifier for each Data Item in the Dataset. Within each Dataset, the idref value must be unique for every occurrence. If a received Dataset uses idrefs and it is expected that the Dataset will be exchanged, the idrefs should be considered required. If the receiving system is the permanent end of the line for the Dataset, the idrefs may be considered optional.
Format is S10
protected String availability
Values should be selected from one of "Unknown", "N/A", "Not Available" or "Not Applicable", when data is not available.
public ListCCL getCls()
ListCCL
instancepublic void setCls(ListCCL value)
value
- a ListCCL
instancepublic Set<BigInteger> getRemarkRef()
BigInteger
instancespublic boolean isSetRemarkRef()
BigInteger
instancespublic void unsetRemarkRef()
public boolean isSetCls()
public String getIdref()
String
instancepublic void setIdref(String value)
value
- a String
instancepublic boolean isSetIdref()
public String getAvailability()
String
instancepublic void setAvailability(String value)
value
- a String
instancepublic boolean isSetAvailability()
public Set<BigInteger> getExtReferences()
BigInteger
instancespublic boolean isSetExtReferences()
public void unsetExtReferences()
public String getLegacyReleasability()
String
instancepublic void setLegacyReleasability(String value)
value
- a String
instancepublic boolean isSetLegacyReleasability()
public String getQuality()
String
instancepublic void setQuality(String value)
value
- a String
instancepublic boolean isSetQuality()
public String getRecommendedValue()
String
instancepublic void setRecommendedValue(String value)
value
- a String
instancepublic boolean isSetRecommendedValue()
public String toString()
public T withCls(ListCCL value)
value
- An instances of type ListCCL
public T withExtReferences(BigInteger... values)
values
- One or more instances of type BigInteger
public T withExtReferences(Set<BigInteger> values)
values
- A collection of BigInteger
instancespublic T withLegacyReleasability(String value)
value
- An instances of type String
public T withQuality(String value)
value
- An instances of type String
public T withRecommendedValue(String value)
value
- An instances of type String
public T withRemarkRef(BigInteger... values)
values
- One or more instances of type BigInteger
public T withRemarkRef(Set<BigInteger> values)
values
- A collection of BigInteger
instancespublic T withIdref(String value)
value
- An instances of type String
public T withAvailability(ListAvailability value)
value
- An instances of type ListAvailability
public boolean isSet()
Note that this method only checks for the presence of required information; this method does not validate the information format.
Copyright © 2016 OpenSSRF.org. All rights reserved.