Package com.luciad.fusion.tilestore.metadata

Class ALfnResourceMetadata.Builder<B extends ALfnResourceMetadata.Builder<B>>

java.lang.Object
com.luciad.fusion.tilestore.metadata.ALfnResourceMetadata.Builder<B>
Type Parameters:
B - the builder type
Direct Known Subclasses:
ALfnAssetMetadata.Builder, ALfnCoverageMetadata.Builder, TLfnThemeMetadata.Builder
Enclosing class:
ALfnResourceMetadata
public abstract static class ALfnResourceMetadata.Builder<B extends ALfnResourceMetadata.Builder<B>> extends Object
Abstract builder for resource metadata. A builder cannot be instantiated directly via a constructor, it must be instantiated via one of the static factory methods on the concrete subclasses of this class.

A builder may be reused to build multiple resources, but it is not thread-safe.

Since:
10.0

  • Method Details

    • globalUpdateSequence

      public final B globalUpdateSequence(long aGlobalUpdateSequence)

      Sets the global update sequence.

      Note that you should normally never call this method. LuciadFusion automatically manages this number for you.

      Parameters:
      aGlobalUpdateSequence - The global update sequence
      Returns:
      this builder
      See Also:

    • id

      public final B id(String aId)
      Sets the required ID of the resource. If not set, or if set to null, the resource will have a default ID generated from UUID.randomUUID().

      For vector coverages, setting the ID will trigger an update of the default data model.

      Parameters:
      aId - the ID, which may be null to reset to default
      Returns:
      this builder
      Since:
      2013.0

    • setId

      public final B setId(String aId)
      Deprecated.
      use id(String) instead

    • name

      public final B name(String aName)
      Sets the optional name of the resource. It will be null if unspecified.
      Parameters:
      aName - the name, may be null
      Returns:
      this builder
      Since:
      2013.0

    • setName

      public final B setName(String aName)
      Deprecated.
      use name(String) instead

    • abstract_

      public final B abstract_(String aAbstract)
      Sets the optional abstract of the resource. It will be null if unspecified. The trailing underscore in the method name is necessary to avoid conflict with the reserved Java keyword abstract.
      Parameters:
      aAbstract - the abstract, may be null
      Returns:
      this builder
      Since:
      2013.0

    • setAbstract

      public final B setAbstract(String aAbstract)
      Deprecated.
      use abstract_(String) instead

    • updateSequence

      public final B updateSequence(long aUpdateSequence)
      Sets the required update sequence (version) of the resource. If not set, or if set to a negative value, the resource will have the default ALfnResourceMetadata.NEW_UPDATE_SEQUENCE.
      Parameters:
      aUpdateSequence - the update sequence, which may be negative to reset to default
      Returns:
      this builder
      Since:
      2013.0

    • setUpdateSequence

      public final B setUpdateSequence(long aUpdateSequence)
      Deprecated.
      use updateSequence(long) instead

    • iso19115Metadata

      public final B iso19115Metadata(TLcdISO19115Metadata aIso19115Metadata)
      Sets the optional ISO 19115 metadata of the resource. It will be null if unspecified.
      Parameters:
      aIso19115Metadata - the metadata, may be null
      Returns:
      this builder
      Since:
      2013.0

    • setISO19115Metadata

      public final B setISO19115Metadata(TLcdISO19115Metadata aIso19115Metadata)
      Deprecated.
      use iso19115Metadata(TLcdISO19115Metadata) instead

    • build

      public abstract ALfnResourceMetadata build()
      Builds an immutable resource. Note that, depending on the builder implementation, this is not necessarily a new object. Builders may optimize memory usage by returning the same objects, for instance if no fields were modified in between two subsequent calls to this method.
      Returns:
      the immutable resource
      Throws:
      NullPointerException - in case one or more required fields have not been set

    • getGlobalUpdateSequence

      public final long getGlobalUpdateSequence()
      Gets this builder's current last global update sequence
      Returns:
      the current last global update sequence
      Since:
      2015.0

    • getId

      public final String getId()
      Gets this builder's current ID.
      Returns:
      the current ID, never null
      Since:
      2012.0

    • getName

      public final String getName()
      Gets this builder's current name.
      Returns:
      the current name, possibly null
      Since:
      2012.0

    • getAbstract

      public final String getAbstract()
      Gets this builder's current abstract.
      Returns:
      the current abstract, possibly null
      Since:
      2012.0

    • getUpdateSequence

      public final long getUpdateSequence()
      Gets this builder's current update sequence.
      Returns:
      the current update sequence, which is never negative
      Since:
      2012.0

    • getISO19115Metadata

      public final TLcdISO19115Metadata getISO19115Metadata()
      Gets this builder's current ISO 19115 metadata.
      Returns:
      the current ISO 19115 metadata, possibly null
      Since:
      2012.0