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;
43 import net.sf.gridarta.utils.IOUtils;
44 import org.apache.log4j.Category;
45 import org.apache.log4j.Logger;
46 import org.jetbrains.annotations.NotNull;
47 import org.jetbrains.annotations.Nullable;
48 
54 public abstract class AbstractCollectedResourcesReader<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends AbstractResourcesReader<G> {
55 
59  private static final Category LOG = Logger.getLogger(AbstractCollectedResourcesReader.class);
60 
64  @NotNull
65  private final File collectedDirectory;
66 
70  @NotNull
72 
76  @NotNull
78 
82  @NotNull
83  private final FaceObjects faceObjects;
84 
88  @NotNull
89  private final String animTreeFile;
90 
94  @NotNull
95  private final String archetypesFile;
96 
108  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) {
110  this.collectedDirectory = collectedDirectory;
111  this.archetypeSet = archetypeSet;
112  this.archetypeParser = archetypeParser;
113  this.faceObjects = faceObjects;
114  this.animTreeFile = animTreeFile;
115  this.archetypesFile = archetypesFile;
116  }
117 
122  protected void loadAnimations(@NotNull final ErrorView errorView) {
123  Map<String, String> animations = null;
124  try {
126  try {
127  animations = loadAnimTree(url);
128  } catch (final IOException ex) {
129  errorView.addWarning(ErrorViewCategory.ANIMTREE_FILE_INVALID, url + ": " + ex.getMessage());
130  }
131  } catch (final IOException ex) {
132  errorView.addWarning(ErrorViewCategory.ANIMTREE_FILE_INVALID, animTreeFile + ": " + ex.getMessage());
133  }
134  loadAnimationsFromCollect(errorView, animations == null ? Collections.emptyMap() : animations);
135  }
136 
142  protected void loadArchetypes(@NotNull final ErrorView errorView, @NotNull final List<G> invObjects) {
144  try {
145  final int archetypeCount = archetypeSet.getArchetypeCount();
146 
148  try {
149  try (InputStream inputStream = url.openStream()) {
150  try (Reader reader = new InputStreamReader(inputStream, IOUtils.MAP_ENCODING)) {
151  try (BufferedReader bufferedReader = new BufferedReader(reader)) {
152  archetypeParser.parseArchetypeFromStream(bufferedReader, null, null, null, "default", "default", "", invObjects, new ErrorViewCollector(errorView, url));
153  }
154  }
155  }
156  } catch (final IOException ex) {
157  errorView.addWarning(ErrorViewCategory.ARCHETYPES_FILE_INVALID, url + ": " + ex.getMessage());
158  }
159 
160  if (LOG.isInfoEnabled()) {
161  LOG.info("Loaded " + (archetypeSet.getArchetypeCount() - archetypeCount) + " archetypes from '" + url + "'.");
162  }
163  } catch (final IOException ex) {
164  errorView.addWarning(ErrorViewCategory.ARCHETYPES_FILE_INVALID, archetypesFile + ": " + ex.getMessage());
165  }
166  }
167 
173  @NotNull
174  protected FaceProvider loadFacesCollection(@NotNull final ErrorView errorView) {
176  }
177 
178 }
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.loadArchetypes
void loadArchetypes(@NotNull final ErrorView errorView, @NotNull final List< G > invObjects)
Definition: AbstractCollectedResourcesReader.java:142
net.sf.gridarta.model.resource.AbstractResourcesReader
Definition: AbstractResourcesReader.java:60
net.sf.gridarta.model.errorview.ErrorView
Definition: ErrorView.java:28
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.animTreeFile
final String animTreeFile
Definition: AbstractCollectedResourcesReader.java:89
net.sf.gridarta.utils.IOUtils.getResource
static URL getResource(@NotNull final File dir, @NotNull final String fileName)
Definition: IOUtils.java:69
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.archetypesFile
final String archetypesFile
Definition: AbstractCollectedResourcesReader.java:95
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.model.archetypeset.ArchetypeSet.setLoadedFromArchive
void setLoadedFromArchive(boolean loadedFromArchive)
net.sf.gridarta.model.errorview.ErrorViewCategory.ARCHETYPES_FILE_INVALID
ARCHETYPES_FILE_INVALID
Definition: ErrorViewCategory.java:52
net.sf.gridarta
net.sf.gridarta.model.errorview.ErrorViewCollector
Definition: ErrorViewCollector.java:31
net.sf.gridarta.model.maparchobject.MapArchObject
Definition: MapArchObject.java:40
net.sf
net.sf.gridarta.model.anim.AnimationObjects
Definition: AnimationObjects.java:30
net.sf.gridarta.model.archetype
Definition: AbstractArchetype.java:20
net.sf.gridarta.model.errorview.ErrorViewCategory.ANIMTREE_FILE_INVALID
ANIMTREE_FILE_INVALID
Definition: ErrorViewCategory.java:40
net.sf.gridarta.model.face.FaceProvider
Definition: FaceProvider.java:30
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.LOG
static final Category LOG
Definition: AbstractCollectedResourcesReader.java:59
net.sf.gridarta.model.gameobject.GameObject
Definition: GameObject.java:36
net.sf.gridarta.utils.IOUtils.MAP_ENCODING
static final String MAP_ENCODING
Definition: IOUtils.java:52
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)
Definition: AbstractCollectedResourcesReader.java:108
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.collectedDirectory
final File collectedDirectory
Definition: AbstractCollectedResourcesReader.java:65
net.sf.gridarta.model.gameobject
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.model.errorview
Definition: ErrorView.java:20
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.faceObjects
final FaceObjects faceObjects
Definition: AbstractCollectedResourcesReader.java:83
net.sf.gridarta.model.resource.AbstractResourcesReader< G >::imageSet
final String imageSet
Definition: AbstractResourcesReader.java:85
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.loadAnimations
void loadAnimations(@NotNull final ErrorView errorView)
Definition: AbstractCollectedResourcesReader.java:122
net.sf.gridarta.model.archetypeset.ArchetypeSet
Definition: ArchetypeSet.java:37
net.sf.gridarta.model.archetypeset.ArchetypeSet.getArchetypeCount
int getArchetypeCount()
net.sf.gridarta.model.resource.AbstractResourcesReader< G >::loadAnimationsFromCollect
void loadAnimationsFromCollect( @NotNull final ErrorView errorView, @NotNull final Map< String, String > animations)
Definition: AbstractResourcesReader.java:118
net.sf.gridarta.model.io
Definition: AbstractArchetypeParser.java:20
net.sf.gridarta.model.resource.AbstractResourcesReader< G >::animationObjects
final AnimationObjects animationObjects
Definition: AbstractResourcesReader.java:91
net.sf.gridarta.model
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.loadFacesCollection
FaceProvider loadFacesCollection(@NotNull final ErrorView errorView)
Definition: AbstractCollectedResourcesReader.java:174
net.sf.gridarta.model.face
Definition: AbstractFaceObjects.java:20
net.sf.gridarta.model.anim
Definition: AbstractAnimationObjects.java:20
net.sf.gridarta.model.io.AbstractArchetypeParser
Definition: AbstractArchetypeParser.java:47
net.sf.gridarta.model.face.FaceObjects.loadFacesCollection
FaceProvider loadFacesCollection(@NotNull ErrorView errorView, @NotNull File collectedDirectory)
net.sf.gridarta.model.errorview.ErrorViewCategory
Definition: ErrorViewCategory.java:28
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.archetypeParser
final AbstractArchetypeParser< G, A, R, ?> archetypeParser
Definition: AbstractCollectedResourcesReader.java:77
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader.archetypeSet
final ArchetypeSet< G, A, R > archetypeSet
Definition: AbstractCollectedResourcesReader.java:71
net.sf.gridarta.utils.IOUtils
Definition: IOUtils.java:40
net.sf.gridarta.model.face.FaceObjects
Definition: FaceObjects.java:31
net.sf.gridarta.model.archetypeset
Definition: ArchetypeSet.java:20
net.sf.gridarta.model.resource.AbstractCollectedResourcesReader
Definition: AbstractCollectedResourcesReader.java:54
net.sf.gridarta.model.resource.AbstractResourcesReader< G >::loadAnimTree
static Map< String, String > loadAnimTree( @NotNull final URL url)
Definition: AbstractResourcesReader.java:217
net.sf.gridarta.model.archetype.Archetype
Definition: Archetype.java:41
net.sf.gridarta.utils
Definition: ActionBuilderUtils.java:20