GBOutputGenerator Class Reference

Discussion

Copies all files from the templates path to the output path as defined in assigned settings, replicating the directory structure and stores all detected template files to templateFiles dictionary.

The method uses [GBApplicationSettingsProvider templatesPath] as the base path for templates and [GBApplicationSettingsProvider outputPath] as the base path for output. In both cases, outputSubpath is used to determine the source and destination subdirectories. It then copies all files from template path to the output path, including the whole directory structure. If any special template file is found at source path, it is not copied! Template files are identified by having a -template suffix followed by optional extension. For example object-template.html. As this message prepares the ground for actual generation, it should be sent before any other messages (i.e. before generateOutput:).

To further aid subclasses, the method reads out all template files in templates path and stores them to templateFiles dictionary. Each template file is stored with a key correspoding to it's filename, including the subdirectory within the base template path and extension.

Note: This message is intended to be sent from higher-level generator objects. Although it would present no error to run it several times, in most circumstances subclasses don't need to send it manually. If copying fails, a warning is logged and copying is stopped. Depending of type of failure, the method either returns YES or NO. If copying of all files is succesful, but reading or clearing template or ignored files fails, the operation is still considered succesful, so YES is returned. However if replicating the directory structure or copying files fails, this is considered an error and NO is returned. In such case, clients should abort further processing.

Discussion

Generates the output at the proper subdirectory of the output path as defined in assigned settings.

This is the most important method of the GBOutputGenerator class. It generates all required output. It is intended to be overriden in subclasses. Default implementation assigns the given store and returns YES. Subclasses must call super class implementation before anything else!

Discussion

Initializes the generator to work with the given GBApplicationSettingsProvider implementor.

This is the designated initializer.

Discussion

Searches templateFiles dictionary for a key ending with the given suffix and returns the whole key if found.

If the key is not found, nil is returned. This method is useful for finding keys for which we only know partial name (ussually the name of the file, but not the path to it).

Discussion

Writes the given string to the given path, creating all necessary directories if they don't exist.

This method is intended to be used from subclass, in most cases from generateOutputWithStore:error:.

Discussion

Returns the path relative to main output path, where all generated data is stored.

At the same this, this also defines the path relative to main templates path, where all template files for this output generator are stored. Default implementation simply returns empty string, each subclass is supposed to override and return prover value.

Discussion

Returns the output path including outputSubpath.

This uses the same string as entered by the user when starting the application. Send stringByStandardizingPath message to the returned value before using it!

Discussion

Returns the GBOutputGenerator that was used just before this one or nil if this is the first generator in this session.

This is useful for subclasses that rely on files generated by previous generator. For example, we can get the location of generated files so we can further manipulate them. If a concrete subclass requires previous generator, and none is provided, it should throw an exception from generateOutputWithStore:error:!

Discussion

The dictionary of all template files detected within copyTemplateFilesToOutputPath:.

Each object has a key of template file name and relative path from templateUserPath. The keys are mapped to GBTemplateHandler instances associated with the template.

This is intended to be used within subclasses only. Dictionary contents are automatically updated and should not be changed by subclasses.

Discussion

Returns user-friendly template path string including outputSubpath.

This uses the same string as entered by the user when starting the application. Send stringByStandardizingPath message to the returned value before using it!