Class Layer
java.lang.Object
de.kappich.pat.gnd.layerManagement.Layer
- All Implemented Interfaces:
Comparable<Layer>
- Direct Known Subclasses:
NoticeLayer
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
ConstructorsConstructorDescriptionLayer()Ein Default-Konstruktor, der z.B. für die Initialisierung mit initializeFromPreferences() benötigt wird.Layer(String layerName, String info, DisplayObjectTypePlugin plugin, String configurationObjectType, ReferenceHierarchy referenceHierarchy, CsvFormat csvFormat, 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 TypeMethodDescriptionvoidaddDisplayObjectType(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.voidDurch Aufruf dieser Methode wird die DOTCollection des Layers geleert.intvoiddeletePreferences(Preferences prefs) Löscht die Präferenzen des Layers unter dem Knoten.booleanDer Getter für den Namen der Klasse, deren Objekte der Layer darstellt.getCopy()Diese Methode gibt eine Kopie des Layers zurück.Gibt dieCSV-Dateides Layers zurück.Gibt dasCsvFormatdes Layers zurück.Gibt die CSV-Initialisierungs-Information zurück.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 die DOTCollection des Layers zurück.getInfo()Der Getter für den Infotext.getName()Der Getter für den Namen.Der Getter für das Plugin des Layers.Gibt dieEOR-Hierarchiedes Layers zurück.Gibt die Menge aller Namen aller Farben, die von den Darstellungstypen in der DOTCollection des Layers verwendet werden, zurück.inthashCode()booleanInitialisiert den Layer aus den Präferenzen unter dem übergebenen Knoten.voidputPreferences(Preferences prefs) Speichert die Präferenzen des Layers unter dem übergebenen Knoten.voidsetConfigurationObjectType(String configurationObjectType) Der Setter für den Namen der Klasse, deren Objekte der Layer darstellt.voidsetCsvFile(File csvFile) Setzt dieCSV-Dateides Layers.voidsetCsvFormat(CsvFormat csvFormat) Setzt dieCsvFormatdes Layers.voidsetCsvInitInfo(String info) Setzt die CSV-Initialisierungs-Information, aber nur für CSV-Layer möglich.voidsetDotCollection(DOTCollection dotCollection) Setzt die DOTCollection des Layers.voidDer Setter für den Infotext.voidDer Setter für den Namen.voidsetPlugin(DisplayObjectTypePlugin plugin) Der Setter für das Plugin.voidsetReferenceHierarchy(ReferenceHierarchy hierarchy) Setzt dieEOR-Hierarchiedes Layers.toString()
-
Constructor Details
-
Layer
public Layer()Ein Default-Konstruktor, der z.B. für die Initialisierung mit initializeFromPreferences() benötigt wird. -
Layer
public Layer(String layerName, @Nullable String info, DisplayObjectTypePlugin plugin, @Nullable String configurationObjectType, @Nullable ReferenceHierarchy referenceHierarchy, @Nullable CsvFormat csvFormat, @Nullable 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 Details
-
getName
Der Getter für den Namen.- Returns:
- den Namen
-
setName
Der Setter für den Namen.- Parameters:
layerName- der Name des Layers
-
getInfo
Der Getter für den Infotext.- Returns:
- der Infotext des Layers
-
setInfo
Der Setter für den Infotext.- Parameters:
info- der Infotext
-
getPlugin
Der Getter für das Plugin des Layers.- Returns:
- das Plugin
-
setPlugin
Der Setter für das Plugin.- Parameters:
plugin- das neue Plugin
-
getConfigurationObjectType
Der Getter für den Namen der Klasse, deren Objekte der Layer darstellt.- Returns:
- der Name der Klasse
-
setConfigurationObjectType
Der Setter für den Namen der Klasse, deren Objekte der Layer darstellt.- Parameters:
configurationObjectType- der Name der Klasse
-
getReferenceHierarchy
Gibt dieEOR-Hierarchiedes Layers zurück.- Returns:
- die EOR-Hierarchie
-
setReferenceHierarchy
Setzt dieEOR-Hierarchiedes Layers.- Parameters:
hierarchy- der neue Wert; kannnullsein
-
getCsvFormat
Gibt dasCsvFormatdes Layers zurück.- Returns:
- ein CsvFormat oder
null
-
setCsvFormat
Setzt dieCsvFormatdes Layers.- Parameters:
csvFormat- der neue Wert; kannnullsein
-
getCsvFile
Gibt dieCSV-Dateides Layers zurück.- Returns:
- eine CSV-Datei oder
null
-
setCsvFile
Setzt dieCSV-Dateides Layers.- Parameters:
csvFile- CSV-Datei der neue Wert; kannnullsein
-
getCsvInitInfo
Gibt die CSV-Initialisierungs-Information zurück.- Returns:
- CSV-Initialisierungs-Information
-
setCsvInitInfo
Setzt die CSV-Initialisierungs-Information, aber nur für CSV-Layer möglich.- Parameters:
info- die Info
-
addDisplayObjectType
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
Gibt die DOTCollection des Layers zurück.- Returns:
- die DOTCollection des Layers
-
setDotCollection
Setzt die DOTCollection des Layers.- Parameters:
dotCollection- die neue DOTCollection des Layers
-
getDisplayObjectType
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
Speichert die Präferenzen des Layers unter dem übergebenen Knoten.- Parameters:
prefs- der Knoten, unter dem die Präferenzen gespeichert werden
-
deletePreferences
Löscht die Präferenzen des Layers unter dem Knoten.- Parameters:
prefs- der Knoten, unter dem die Präferenzen gelöscht werden
-
initializeFromPreferences
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
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
-
getCopy
Diese Methode gibt eine Kopie des Layers zurück.- Returns:
- die Kopie
-
compareTo
- Specified by:
compareToin interfaceComparable<Layer>
-
equals
-
hashCode
public int hashCode()
-