aboutsummaryrefslogtreecommitdiffstats
path: root/Source/SPExportFile.h
diff options
context:
space:
mode:
authorstuconnolly <stuart02@gmail.com>2010-08-12 12:56:20 +0000
committerstuconnolly <stuart02@gmail.com>2010-08-12 12:56:20 +0000
commitfc02f913371d522a025c47824fafeba8e3174da1 (patch)
tree086561fd418bf35139dda47d698d7923196a4f30 /Source/SPExportFile.h
parent50f15c41936be3fb62384834bb3629e09018e67b (diff)
downloadsequelpro-fc02f913371d522a025c47824fafeba8e3174da1.tar.gz
sequelpro-fc02f913371d522a025c47824fafeba8e3174da1.tar.bz2
sequelpro-fc02f913371d522a025c47824fafeba8e3174da1.zip
Various export enhancements and fixes, including:
- A new SPExportFile class, providing an abstract interface to the handling and creation of export files. - Enables the centralisation of all file/file handle creation logic as well as better support for handling situations where files fail to be created, including files that already exist at the export location. - New SPExportFileHandleStatus constants to support the reporting of file handle creation. - Update SPExporter to use the new file class instead of directly using an instance of SPFileHandle. - Add the necessary logic to deal with files that already exist on disk, by providing the user with 3 options: cancel the export, ignore the files in question or overwrite them. We might want to enhance this to make new files sequential in name to prevent overwriting. Fixes issue #742. - New SPExportFileUtilities category, which centralises all the logic relating to writing export type headers as well as dealing with problems occurred during file/file handle creation. - Improve feedback given on the export progress sheet during export initialisation. - Tidy up and improve comments.
Diffstat (limited to 'Source/SPExportFile.h')
-rw-r--r--Source/SPExportFile.h86
1 files changed, 86 insertions, 0 deletions
diff --git a/Source/SPExportFile.h b/Source/SPExportFile.h
new file mode 100644
index 00000000..fb61eef2
--- /dev/null
+++ b/Source/SPExportFile.h
@@ -0,0 +1,86 @@
+//
+// $Id$
+//
+// SPExportFile.h
+// sequel-pro
+//
+// Created by Stuart Connolly (stuconnolly.com) on July 31, 2010
+// Copyright (c) 2010 Stuart Connolly. All rights reserved.
+//
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// More info at <http://code.google.com/p/sequel-pro/>
+
+#import "SPConstants.h"
+
+@class SPFileHandle;
+
+/**
+ * @class SPExportFile SPExportFile.h
+ *
+ * @author Stuart Connolly http://stuconnolly.com/
+ *
+ * This class represents an abstract export file regardless of whether the file on disk actually exists on
+ * disk upon initialization. It provides multiple convenience methods for accessing the underlying file handle
+ * (SPFileHandle instance) as well as logic to deal with situations whether there are problems (file already
+ * exists, etc) creating the file and estabslishing a handle to it.
+ */
+@interface SPExportFile : NSObject
+{
+ NSString *exportFilePath;
+
+ BOOL exportFileNeedsCSVHeader;
+ BOOL exportFileNeedsXMLHeader;
+
+ SPFileHandle *exportFileHandle;
+
+ SPExportFileHandleStatus exportFileHandleStatus;
+}
+
+/**
+ * @property exportFilePath
+ */
+@property (readwrite, retain) NSString *exportFilePath;
+
+/**
+ * @property exportFileHandle
+ */
+@property (readonly) SPFileHandle *exportFileHandle;
+
+/**
+ * @property exportFileNeedsCSVHeader
+ */
+@property (readwrite, assign) BOOL exportFileNeedsCSVHeader;
+
+/**
+ * @property exportFileNeedsXMLHeader
+ */
+@property (readwrite, assign) BOOL exportFileNeedsXMLHeader;
+
+/**
+ * @property exportFileHandleStatus
+ */
+@property (readonly) SPExportFileHandleStatus exportFileHandleStatus;
+
++ (SPExportFile *)exportFileAtPath:(NSString *)path;
+
+- (id)initWithFilePath:(NSString *)path;
+
+- (void)close;
+- (BOOL)delete;
+- (void)writeData:(NSData *)data;
+- (SPExportFileHandleStatus)createExportFileHandle:(BOOL)overwrite;
+
+@end