Package org.geotools.coverage.grid.io.imageio

Class IIOMetadataDumper

  • public final class IIOMetadataDumper
extends Object
    Utility class that can be used to dump a DOM tree in a formatted way.

    It is useful for inspecting the metadata inside GeoTiff files.

    Since:
    2.3.x
    Author:
    Simone Giannecchini

    • Constructor Summary

      Constructors 
      Constructor Description
      IIOMetadataDumper​(IIOMetadataNode rootNode)
      Constructor for a IIOMetadataDumper accepting an IIOMetadataNode.
      IIOMetadataDumper​(IIOMetadata metadata, String name)
      Constructor for a IIOMetadataDumper accepting and IIOMetadata and a String for the format name of the XML metadata to use.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getFormatName()
      Retrieves the name of the format we want to get the XML representation for.
      String getMetadata()
      Allows me to get the generated XML representation for the underlying tree;
      void setFormatName​(String formatName)
      Sets the name of the format we want to get the XML representation for.

      • Methods inherited from class Object

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

    • Constructor Detail

      • IIOMetadataDumper

        public IIOMetadataDumper​(IIOMetadata metadata,
                         String name)
        Constructor for a IIOMetadataDumper accepting and IIOMetadata and a String for the format name of the XML metadata to use.
        Parameters:
        metadata - The metadta to display.
        name - The format of the metaata to display.

      • IIOMetadataDumper

        public IIOMetadataDumper​(IIOMetadataNode rootNode)
        Constructor for a IIOMetadataDumper accepting an IIOMetadataNode. It has no way to choose the format of the metadata to parse since this choice has been already done previously.

    • Method Detail

      • getMetadata

        public String getMetadata()
        Allows me to get the generated XML representation for the underlying tree;
        Returns:
        A formatted XML string.

      • getFormatName

        public String getFormatName()
        Retrieves the name of the format we want to get the XML representation for.
        Returns:
        The name of the format we want to get the XML representation for.

      • setFormatName

        public void setFormatName​(String formatName)
        Sets the name of the format we want to get the XML representation for.

        This method causes a new generation of the string representation if the format is different from the one stored.

        Parameters:
        formatName - The name of the format we want to get the XML representation for.