Package org.codice.alliance.transformer.nitf.common

Interface NitfAttribute<T>

Type Parameters:
T - The type of CommonNitfSegment that implementations of NitfAttribute represent.
All Known Implementing Classes:
AcftbAttribute, AimidbAttribute, CmetaaAttribute, CsdidaAttribute, CsexraAttribute, ExpltbAttribute, GraphicAttribute, HistoaAttribute, ImageAttribute, IndexedMtirpbAttribute, IndexedPiaprdAttribute, LabelAttribute, MtirpbAttribute, NitfAttributeImpl, NitfHeaderAttribute, PiaimcAttribute, PiaprdAttribute, PiatgbAttribute, StdidcAttribute, SymbolAttribute, TextAttribute
public interface NitfAttribute<T>
An interface to provide access to common properties of NITF metacard segment attributes. The accessor function is used to extract an attribute value from the CommonNitfSegment that contains it. This interface allows the transformer to access NitfAttributes in a generic way.

  • Method Details

    • getLongName

      String getLongName()
      Returns:
      the attribute's long name in CamelCase.

    • getShortName

      String getShortName()
      Returns:
      the attribute's short name as listed in MIL-STD-2500C.

    • getAccessorFunction

      Function<T,Serializable> getAccessorFunction() throws NitfAttributeTransformException
      Returns:
      a function that, given the CommonNitfSegment of type T, will return the corresponding value for the NitfAttribute as a Serializable. The function should return null if the value cannot be computed.
      Throws:
      NitfAttributeTransformException - when there is an error parsing the NitfAttribute

    • getExtAccessorFunction

      Function<T,Serializable> getExtAccessorFunction() throws NitfAttributeTransformException
      Returns:
      a function that, given the CommonNitfSegment of type T, will return the corresponding value for the extended NitfAttribute as a Serializable. The function should return null if the value cannot be computed.
      Throws:
      NitfAttributeTransformException - when there is an error parsing the NitfAttribute

    • getAttributeDescriptors

      Set<ddf.catalog.data.AttributeDescriptor> getAttributeDescriptors()
      Returns:
      AttributeDescriptors for this attribute.