Class Layer
- java.lang.Object
-
- de.kappich.pat.gnd.layerManagement.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 Summary
Constructors Constructor Description Layer()Ein Default-Konstruktor, der z.B. für die Initialisierung mit initializeFromPreferences() benötigt wird.Layer(java.lang.String layerName, java.lang.String info, DisplayObjectTypePlugin plugin, java.lang.String configurationObjectType, ReferenceHierarchy referenceHierarchy, CsvFormat csvFormat, 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.
-
Method Summary
Modifier and Type Method Description voidaddDisplayObjectType(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.voidclearDisplayObjectTypes()Durch Aufruf dieser Methode wird die DOTCollection des Layers geleert.intcompareTo(Layer o)voiddeletePreferences(java.util.prefs.Preferences prefs)Löscht die Präferenzen des Layers unter dem Knoten.booleanequals(java.lang.Object o)java.lang.StringgetConfigurationObjectType()Der Getter für den Namen der Klasse, deren Objekte der Layer darstellt.LayergetCopy()Diese Methode gibt eine Kopie des Layers zurück.java.io.FilegetCsvFile()Gibt dieCSV-Dateides Layers zurück.CsvFormatgetCsvFormat()Gibt dasCsvFormatdes Layers zurück.java.lang.StringgetCsvInitInfo()Gibt die CSV-Initialisierungs-Information zurück.DisplayObjectTypegetDisplayObjectType(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.DOTCollectiongetDotCollection()Gibt die DOTCollection des Layers zurück.java.lang.StringgetInfo()Der Getter für den Infotext.java.lang.StringgetName()Der Getter für den Namen.DisplayObjectTypePlugingetPlugin()Der Getter für das Plugin des Layers.ReferenceHierarchygetReferenceHierarchy()Gibt dieEOR-Hierarchiedes Layers zurück.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.inthashCode()booleaninitializeFromPreferences(java.util.prefs.Preferences prefs)Initialisiert den Layer aus den Präferenzen unter dem übergebenen Knoten.voidputPreferences(java.util.prefs.Preferences prefs)Speichert die Präferenzen des Layers unter dem übergebenen Knoten.voidsetConfigurationObjectType(java.lang.String configurationObjectType)Der Setter für den Namen der Klasse, deren Objekte der Layer darstellt.voidsetCsvFile(java.io.File csvFile)Setzt dieCSV-Dateides Layers.voidsetCsvFormat(CsvFormat csvFormat)Setzt dieCsvFormatdes Layers.voidsetCsvInitInfo(java.lang.String info)Setzt die CSV-Initialisierungs-Information, aber nur für CSV-Layer möglich.voidsetDotCollection(DOTCollection dotCollection)Setzt die DOTCollection des Layers.voidsetInfo(java.lang.String info)Der Setter für den Infotext.voidsetName(java.lang.String layerName)Der Setter für den Namen.voidsetPlugin(DisplayObjectTypePlugin plugin)Der Setter für das Plugin.voidsetReferenceHierarchy(ReferenceHierarchy hierarchy)Setzt dieEOR-Hierarchiedes Layers.java.lang.StringtoString()
-
-
-
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 Layersinfo- der Infotext zum Layerplugin- der Name eine Attributgruppe odernullconfigurationObjectType- 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
-
getReferenceHierarchy
@Nullable public ReferenceHierarchy getReferenceHierarchy()
Gibt dieEOR-Hierarchiedes Layers zurück.- Returns:
- die EOR-Hierarchie
-
setReferenceHierarchy
public void setReferenceHierarchy(@Nullable ReferenceHierarchy hierarchy)Setzt dieEOR-Hierarchiedes Layers.- Parameters:
hierarchy- der neue Wert; kannnullsein
-
getCsvFormat
@Nullable public CsvFormat getCsvFormat()
Gibt dasCsvFormatdes Layers zurück.- Returns:
- ein CsvFormat oder
null
-
setCsvFormat
public void setCsvFormat(@Nullable CsvFormat csvFormat)Setzt dieCsvFormatdes Layers.- Parameters:
csvFormat- der neue Wert; kannnullsein
-
getCsvFile
@Nullable public java.io.File getCsvFile()
Gibt dieCSV-Dateides Layers zurück.- Returns:
- eine CSV-Datei oder
null
-
setCsvFile
public void setCsvFile(@Nullable java.io.File csvFile)Setzt dieCSV-Dateides Layers.- Parameters:
csvFile- CSV-Datei der neue Wert; kannnullsein
-
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 vonnullverschieden 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
truezurück, wenn die Initialisierung erfolgreich war, undfalse, 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:
toStringin classjava.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:
compareToin interfacejava.lang.Comparable<Layer>
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
-