Class Layer

  • All Implemented Interfaces:
    java.lang.Comparable<Layer>
    Direct Known Subclasses:
    NoticeLayer

    public class Layer
    extends java.lang.Object
    implements java.lang.Comparable<Layer>
    Ein Klasse, die festgelegt, welche Objekte zu ihr gehören und wie diese dargestellt werden.

    Ein Layer hat folgende wesentlichen Bestandteile: seinen Namen, der als eindeutige Kennung verwendet wird, sowie einen Infotext und einen Plugin-Namen. Darüberhinaus können die Pid eines SystemObjektTypes, eine EOR-Hierarchie, sowie ein CSV-Format und eine CSV-Datei angegeben sein.

    • Constructor Detail

      • Layer

        public Layer()
        Ein Default-Konstruktor, der z.B. für die Initialisierung mit initializeFromPreferences() benötigt wird.
      • Layer

        public Layer​(java.lang.String layerName,
                     @Nullable
                     java.lang.String info,
                     DisplayObjectTypePlugin plugin,
                     @Nullable
                     java.lang.String configurationObjectType,
                     @Nullable
                     ReferenceHierarchy referenceHierarchy,
                     @Nullable
                     CsvFormat csvFormat,
                     @Nullable
                     java.io.File csvFile)
        Im folgenden Konstruktor werden dem Layer seine wesentlichen Bestandteile mitgegeben, während die DOTCollection über verschiedene Methoden später bearbeitet werden kann.
        Parameters:
        layerName - der Name des Layers
        info - der Infotext zum Layer
        plugin - der Name eine Attributgruppe oder null
        configurationObjectType - die Pid eines SystemObjectTypes
    • Method Detail

      • getName

        public java.lang.String getName()
        Der Getter für den Namen.
        Returns:
        den Namen
      • setName

        public void setName​(java.lang.String layerName)
        Der Setter für den Namen.
        Parameters:
        layerName - der Name des Layers
      • getInfo

        public java.lang.String getInfo()
        Der Getter für den Infotext.
        Returns:
        der Infotext des Layers
      • setInfo

        public void setInfo​(java.lang.String info)
        Der Setter für den Infotext.
        Parameters:
        info - der Infotext
      • getPlugin

        public DisplayObjectTypePlugin getPlugin()
        Der Getter für das Plugin des Layers.
        Returns:
        das Plugin
      • setPlugin

        public void setPlugin​(DisplayObjectTypePlugin plugin)
        Der Setter für das Plugin.
        Parameters:
        plugin - das neue Plugin
      • getConfigurationObjectType

        public java.lang.String getConfigurationObjectType()
        Der Getter für den Namen der Klasse, deren Objekte der Layer darstellt.
        Returns:
        der Name der Klasse
      • setConfigurationObjectType

        public void setConfigurationObjectType​(java.lang.String configurationObjectType)
        Der Setter für den Namen der Klasse, deren Objekte der Layer darstellt.
        Parameters:
        configurationObjectType - der Name der Klasse
      • setReferenceHierarchy

        public void setReferenceHierarchy​(@Nullable
                                          ReferenceHierarchy hierarchy)
        Setzt die EOR-Hierarchie des Layers.
        Parameters:
        hierarchy - der neue Wert; kann null sein
      • getCsvFormat

        @Nullable
        public CsvFormat getCsvFormat()
        Gibt das CsvFormat des Layers zurück.
        Returns:
        ein CsvFormat oder null
      • setCsvFormat

        public void setCsvFormat​(@Nullable
                                 CsvFormat csvFormat)
        Setzt die CsvFormat des Layers.
        Parameters:
        csvFormat - der neue Wert; kann null sein
      • getCsvFile

        @Nullable
        public java.io.File getCsvFile()
        Gibt die CSV-Datei des Layers zurück.
        Returns:
        eine CSV-Datei oder null
      • setCsvFile

        public void setCsvFile​(@Nullable
                               java.io.File csvFile)
        Setzt die CSV-Datei des Layers.
        Parameters:
        csvFile - CSV-Datei der neue Wert; kann null sein
      • getCsvInitInfo

        @Nullable
        public java.lang.String getCsvInitInfo()
        Gibt die CSV-Initialisierungs-Information zurück.
        Returns:
        CSV-Initialisierungs-Information
      • setCsvInitInfo

        public void setCsvInitInfo​(java.lang.String info)
        Setzt die CSV-Initialisierungs-Information, aber nur für CSV-Layer möglich.
        Parameters:
        info - die Info
      • addDisplayObjectType

        public void addDisplayObjectType​(DisplayObjectType type,
                                         int lowerScale,
                                         int upperScale)
        Mit dieser Methode kann man der DOTCollection des Layers einen Darstellungstypen hinzufügen, und muss dabei das Intervall für das er gelten soll, angeben. Der Darstellungstyp muss von null verschieden sein, und lowerScale muss mindestens so groß wie upperScale sein (es handelt sich um die Xe der 1:X-Werte von Maßstäben).
      • clearDisplayObjectTypes

        public void clearDisplayObjectTypes()
        Durch Aufruf dieser Methode wird die DOTCollection des Layers geleert.
      • getDotCollection

        public DOTCollection getDotCollection()
        Gibt die DOTCollection des Layers zurück.
        Returns:
        die DOTCollection des Layers
      • setDotCollection

        public void setDotCollection​(DOTCollection dotCollection)
        Setzt die DOTCollection des Layers.
        Parameters:
        dotCollection - die neue DOTCollection des Layers
      • getDisplayObjectType

        @Nullable
        public DisplayObjectType getDisplayObjectType​(int scale)
        Gibt einen Darstellungstypen für den übergebenen 1:X-Maßstabswert zurück, falls es in der DOTCollection einen solchen für diesen Wert gibt. Gibt es mehr als einen, so ist nicht festgelegt, welchen man erhält. Gibt es keinen, so erhält man null als Rückgabewert.
        Parameters:
        scale - ein Maßstabswert
        Returns:
        ein zugehöriger Darstellungstyp
      • putPreferences

        public void putPreferences​(java.util.prefs.Preferences prefs)
        Speichert die Präferenzen des Layers unter dem übergebenen Knoten.
        Parameters:
        prefs - der Knoten, unter dem die Präferenzen gespeichert werden
      • deletePreferences

        public void deletePreferences​(java.util.prefs.Preferences prefs)
        Löscht die Präferenzen des Layers unter dem Knoten.
        Parameters:
        prefs - der Knoten, unter dem die Präferenzen gelöscht werden
      • initializeFromPreferences

        public boolean initializeFromPreferences​(java.util.prefs.Preferences prefs)
        Initialisiert den Layer aus den Präferenzen unter dem übergebenen Knoten.
        Parameters:
        prefs - der Knoten, unter dem die Präferenzen gesucht werden
        Returns:
        gibt true zurück, wenn die Initialisierung erfolgreich war, und false, falls nicht
      • getUsedColors

        public java.util.Set<java.lang.String> getUsedColors()
        Gibt die Menge aller Namen aller Farben, die von den Darstellungstypen in der DOTCollection des Layers verwendet werden, zurück.
        Returns:
        die Namen aller benutzten Farben
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • getCopy

        public Layer getCopy()
        Diese Methode gibt eine Kopie des Layers zurück.
        Returns:
        die Kopie
      • compareTo

        public int compareTo​(Layer o)
        Specified by:
        compareTo in interface java.lang.Comparable<Layer>
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object