Gridarta Editor
AbstractCollectedResourcesReader.java
Go to the documentation of this file.
1 /*
2  * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
3  * Copyright (C) 2000-2023 The Gridarta Developers.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 package net.sf.gridarta.model.resource;
21 
22 import java.io.BufferedReader;
23 import java.io.File;
24 import java.io.IOException;
25 import java.io.InputStream;
26 import java.io.InputStreamReader;
27 import java.io.Reader;
28 import java.net.URL;
29 import java.util.Collections;
30 import java.util.List;
31 import java.util.Map;
44 import net.sf.gridarta.utils.IOUtils;
45 import org.apache.log4j.Category;
46 import org.apache.log4j.Logger;
47 import org.jetbrains.annotations.NotNull;
48 import org.jetbrains.annotations.Nullable;
49 
55 public abstract class AbstractCollectedResourcesReader<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractResourcesReader<G> {
56 
60  private static final Category LOG = Logger.getLogger(AbstractCollectedResourcesReader.class);
61 
65  @NotNull
66  private final File collectedDirectory;
67 
71  @NotNull
73 
77  @NotNull
79 
83  @NotNull
84  private final FaceObjects faceObjects;
85 
89  @NotNull
90  private final String animTreeFile;
91 
95  @NotNull
96  private final String archetypesFile;
97 
101  @NotNull
103 
117  protected AbstractCollectedResourcesReader(@NotNull final File collectedDirectory, @Nullable final String imageSet, @NotNull final ArchetypeSet<G, A, R> archetypeSet, @NotNull final AbstractArchetypeParser<G, A, R, ?> archetypeParser, @NotNull final AnimationObjects animationObjects, @NotNull final FaceObjects faceObjects, @NotNull final String animTreeFile, @NotNull final String archetypesFile, @NotNull final AbstractAnimationObjectsReader animationObjectsReader) {
119  this.collectedDirectory = collectedDirectory;
120  this.archetypeSet = archetypeSet;
121  this.archetypeParser = archetypeParser;
122  this.faceObjects = faceObjects;
123  this.animTreeFile = animTreeFile;
124  this.archetypesFile = archetypesFile;
125  this.animationObjectsReader = animationObjectsReader;
126  }
127 
132  protected void loadAnimations(@NotNull final ErrorView errorView) {
133  Map<String, String> animations = null;
134  try {
136  try {
137  animations = loadAnimTree(url);
138  } catch (final IOException ex) {
139  errorView.addWarning(ErrorViewCategory.ANIMTREE_FILE_INVALID, url + ": " + ex.getMessage());
140  }
141  } catch (final IOException ex) {
142  errorView.addWarning(ErrorViewCategory.ANIMTREE_FILE_INVALID, animTreeFile + ": " + ex.getMessage());
143  }
144  loadAnimationsFromCollect(errorView, animations == null ? Collections.emptyMap() : animations, animationObjectsReader);
145  }
146 
152  protected void loadArchetypes(@NotNull final ErrorView errorView, @NotNull final List<G> invObjects) {
154  try {
155  final int archetypeCount = archetypeSet.getArchetypeCount();
156 
158  try {
159  try (InputStream inputStream = url.openStream()) {
160  try (Reader reader = new InputStreamReader(inputStream, IOUtils.MAP_ENCODING)) {
161  try (BufferedReader bufferedReader = new BufferedReader(reader)) {
162  archetypeParser.parseArchetypeFromStream(bufferedReader, null, null, null, "default", "default", "", invObjects, new ErrorViewCollector(errorView, url));
163  }
164  }
165  }
166  } catch (final IOException ex) {
167  errorView.addWarning(ErrorViewCategory.ARCHETYPES_FILE_INVALID, url + ": " + ex.getMessage());
168  }
169 
170  if (LOG.isInfoEnabled()) {
171  LOG.info("Loaded " + (archetypeSet.getArchetypeCount() - archetypeCount) + " archetypes from '" + url + "'.");
172  }
173  } catch (final IOException ex) {
174  errorView.addWarning(ErrorViewCategory.ARCHETYPES_FILE_INVALID, archetypesFile + ": " + ex.getMessage());
175  }
176  }
177 
183  @NotNull
184  protected FaceProvider loadFacesCollection(@NotNull final ErrorView errorView) {
186  }
187 
188 }
net.sf.gridarta.utils.IOUtils.getResource
static URL getResource(@NotNull final File dir, @NotNull final String fileName)
Get the URL of a resource.
Definition: IOUtils.java:69
net.sf.gridarta.model.face.FaceProvider
This interface represents a lazy loader that provides images on demand.
Definition: FaceProvider.java:30
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.AbstractCollectedResourcesReader
AbstractCollectedResourcesReader(@NotNull final File collectedDirectory, @Nullable final String imageSet, @NotNull final ArchetypeSet< G, A, R > archetypeSet, @NotNull final AbstractArchetypeParser< G, A, R, ?> archetypeParser, @NotNull final AnimationObjects animationObjects, @NotNull final FaceObjects faceObjects, @NotNull final String animTreeFile, @NotNull final String archetypesFile, @NotNull final AbstractAnimationObjectsReader animationObjectsReader)
Creates a new instance.
Definition: AbstractCollectedResourcesReader.java:117
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.collectedDirectory
final File collectedDirectory
The collected directory.
Definition: AbstractCollectedResourcesReader.java:66
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.archetypeParser
final AbstractArchetypeParser< G, A, R, ?> archetypeParser
The AbstractArchetypeParser to use.
Definition: AbstractCollectedResourcesReader.java:78
net.sf.gridarta.model.resource.AbstractResourcesReader< G >::loadAnimationsFromCollect
void loadAnimationsFromCollect( @NotNull final ErrorView errorView, @NotNull final Map< String, String > animations, @NotNull final AbstractAnimationObjectsReader animationObjectsReader)
Loads all animations from the big collected animations file.
Definition: AbstractResourcesReader.java:120
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.model.io.AbstractArchetypeParser
Abstract base implementation of ArchetypeParser.
Definition: AbstractArchetypeParser.java:47
net.sf.gridarta.model.anim.AnimationObjects
AnimationObjects is a container for AnimationObjects.
Definition: AnimationObjects.java:30
net.sf.gridarta.model.resource.AbstractResourcesReader
Abstract base class for archetype set loader classes.
Definition: AbstractResourcesReader.java:60
net.sf.gridarta.model.archetypeset.ArchetypeSet.setLoadedFromArchive
void setLoadedFromArchive(boolean loadedFromArchive)
Sets whether Archetypes were loaded from an archive.
net.sf
net.sf.gridarta.model.resource.AbstractResourcesReader< G >::animationObjects
final AnimationObjects animationObjects
The animation objects instance.
Definition: AbstractResourcesReader.java:91
net.sf.gridarta.model.io.AbstractAnimationObjectsReader
Utility class for reading AnimationObjects from files.
Definition: AbstractAnimationObjectsReader.java:44
net.sf.gridarta.model.errorview.ErrorView
Interface for classes displaying error messages.
Definition: ErrorView.java:28
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.archetypeSet
final ArchetypeSet< G, A, R > archetypeSet
The ArchetypeSet to update.
Definition: AbstractCollectedResourcesReader.java:72
net.sf.gridarta.model.archetype
Definition: AbstractArchetype.java:20
net.sf.gridarta.model.gameobject.GameObject
Reflects a game object (object on a map).
Definition: GameObject.java:36
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.loadAnimations
void loadAnimations(@NotNull final ErrorView errorView)
Loads all animations.
Definition: AbstractCollectedResourcesReader.java:132
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.loadArchetypes
void loadArchetypes(@NotNull final ErrorView errorView, @NotNull final List< G > invObjects)
Loads all archetypes.
Definition: AbstractCollectedResourcesReader.java:152
net
net.sf.gridarta.model.errorview
Definition: ErrorView.java:20
net.sf.gridarta.model.archetypeset.ArchetypeSet.getArchetypeCount
int getArchetypeCount()
Returns the number of Archetypes available.
net.sf.gridarta.model.errorview.ErrorViewCollector
Convenience class for adding messages to a ErrorView instance using a fixed category name.
Definition: ErrorViewCollector.java:31
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.animTreeFile
final String animTreeFile
The name of the animation tree information file.
Definition: AbstractCollectedResourcesReader.java:90
net.sf.gridarta.model.errorview.ErrorViewCategory
Defines possible error categories for ErrorView instances.
Definition: ErrorViewCategory.java:28
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.resource.AbstractResourcesReader< G >::imageSet
final String imageSet
The current image set.
Definition: AbstractResourcesReader.java:85
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.LOG
static final Category LOG
The logger for printing log messages.
Definition: AbstractCollectedResourcesReader.java:60
net.sf.gridarta.model.face.FaceObjects
FaceObjects is a container for FaceObjects.
Definition: FaceObjects.java:31
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.archetypesFile
final String archetypesFile
The name of the collected archetypes file.
Definition: AbstractCollectedResourcesReader.java:96
net.sf.gridarta.model.archetypeset.ArchetypeSet
Interface that captures similarities between different ArchetypeSet implementations.
Definition: ArchetypeSet.java:37
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader
Abstract base class for AbstractResourcesReaders that read from collected files.
Definition: AbstractCollectedResourcesReader.java:55
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.loadFacesCollection
FaceProvider loadFacesCollection(@NotNull final ErrorView errorView)
Loads all faces.
Definition: AbstractCollectedResourcesReader.java:184
net.sf.gridarta.model.io
Reading and writing of maps, handling of paths.
Definition: AbstractAnimationObjectsReader.java:20
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.model.errorview.ErrorViewCategory.ANIMTREE_FILE_INVALID
ANIMTREE_FILE_INVALID
Definition: ErrorViewCategory.java:40
net.sf.gridarta.utils.IOUtils
Utility-class for Gridarta's I/O.
Definition: IOUtils.java:40
net.sf.gridarta.model.face
The face is the appearance of an object.
Definition: AbstractFaceObjects.java:20
net.sf.gridarta.model.anim
Gridarta can handle frame information of animations and allow the selection of an animation using a t...
Definition: AbstractAnimationObjects.java:20
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.animationObjectsReader
final AbstractAnimationObjectsReader animationObjectsReader
The animation objects reader to use.
Definition: AbstractCollectedResourcesReader.java:102
net.sf.gridarta.model.errorview.ErrorViewCategory.ARCHETYPES_FILE_INVALID
ARCHETYPES_FILE_INVALID
Definition: ErrorViewCategory.java:52
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.faceObjects
final FaceObjects faceObjects
The FaceObjects instance.
Definition: AbstractCollectedResourcesReader.java:84
net.sf.gridarta.model.face.FaceObjects.loadFacesCollection
FaceProvider loadFacesCollection(@NotNull ErrorView errorView, @NotNull File collectedDirectory)
Loads all faces from a png collection file.
net.sf.gridarta.model.archetypeset
Definition: ArchetypeSet.java:20
net.sf.gridarta.model.io.AbstractArchetypeParser.parseArchetypeFromStream
void parseArchetypeFromStream(@NotNull final BufferedReader in, @Nullable final R prototype, @Nullable final String line, @Nullable final String archName, @NotNull final String panelName, @NotNull final String folderName, @NotNull final String archPath, @NotNull final List< G > invObjects, @NotNull final ErrorViewCollector errorViewCollector)
Definition: AbstractArchetypeParser.java:86
net.sf.gridarta.utils
Definition: ActionBuilderUtils.java:20
net.sf.gridarta.model.resource.AbstractResourcesReader< G >::loadAnimTree
static Map< String, String > loadAnimTree( @NotNull final URL url)
Loads animations from a file.
Definition: AbstractResourcesReader.java:219
net.sf.gridarta.utils.IOUtils.MAP_ENCODING
static final String MAP_ENCODING
Encoding to use for maps and other data.
Definition: IOUtils.java:52