f7f338e265
git-svn-id: http://svn.openlayers.org/branches/openlayers/2.7@8012 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
104 lines
3.3 KiB
JavaScript
104 lines
3.3 KiB
JavaScript
/* Copyright (c) 2006-2008 MetaCarta, Inc., published under the Clear BSD
|
|
* license. See http://svn.openlayers.org/trunk/openlayers/license.txt for the
|
|
* full text of the license. */
|
|
|
|
/**
|
|
* @requires OpenLayers/Util.js
|
|
*/
|
|
|
|
/**
|
|
* Class: OpenLayers.Format
|
|
* Base class for format reading/writing a variety of formats. Subclasses
|
|
* of OpenLayers.Format are expected to have read and write methods.
|
|
*/
|
|
OpenLayers.Format = OpenLayers.Class({
|
|
|
|
/**
|
|
* Property: options
|
|
* {Object} A reference to options passed to the constructor.
|
|
*/
|
|
options: null,
|
|
|
|
/**
|
|
* APIProperty: externalProjection
|
|
* {<OpenLayers.Projection>} When passed a externalProjection and
|
|
* internalProjection, the format will reproject the geometries it
|
|
* reads or writes. The externalProjection is the projection used by
|
|
* the content which is passed into read or which comes out of write.
|
|
* In order to reproject, a projection transformation function for the
|
|
* specified projections must be available. This support may be
|
|
* provided via proj4js or via a custom transformation function. See
|
|
* {<OpenLayers.Projection.addTransform>} for more information on
|
|
* custom transformations.
|
|
*/
|
|
externalProjection: null,
|
|
|
|
/**
|
|
* APIProperty: internalProjection
|
|
* {<OpenLayers.Projection>} When passed a externalProjection and
|
|
* internalProjection, the format will reproject the geometries it
|
|
* reads or writes. The internalProjection is the projection used by
|
|
* the geometries which are returned by read or which are passed into
|
|
* write. In order to reproject, a projection transformation function
|
|
* for the specified projections must be available. This support may be
|
|
* provided via proj4js or via a custom transformation function. See
|
|
* {<OpenLayers.Projection.addTransform>} for more information on
|
|
* custom transformations.
|
|
*/
|
|
internalProjection: null,
|
|
|
|
/**
|
|
* Constructor: OpenLayers.Format
|
|
* Instances of this class are not useful. See one of the subclasses.
|
|
*
|
|
* Parameters:
|
|
* options - {Object} An optional object with properties to set on the
|
|
* format
|
|
*
|
|
* Returns:
|
|
* An instance of OpenLayers.Format
|
|
*/
|
|
initialize: function(options) {
|
|
OpenLayers.Util.extend(this, options);
|
|
this.options = options;
|
|
},
|
|
|
|
/**
|
|
* APIMethod: destroy
|
|
* Clean up.
|
|
*/
|
|
destroy: function() {
|
|
},
|
|
|
|
/**
|
|
* Method: read
|
|
* Read data from a string, and return an object whose type depends on the
|
|
* subclass.
|
|
*
|
|
* Parameters:
|
|
* data - {string} Data to read/parse.
|
|
*
|
|
* Returns:
|
|
* Depends on the subclass
|
|
*/
|
|
read: function(data) {
|
|
OpenLayers.Console.userError(OpenLayers.i18n("readNotImplemented"));
|
|
},
|
|
|
|
/**
|
|
* Method: write
|
|
* Accept an object, and return a string.
|
|
*
|
|
* Parameters:
|
|
* object - {Object} Object to be serialized
|
|
*
|
|
* Returns:
|
|
* {String} A string representation of the object.
|
|
*/
|
|
write: function(object) {
|
|
OpenLayers.Console.userError(OpenLayers.i18n("writeNotImplemented"));
|
|
},
|
|
|
|
CLASS_NAME: "OpenLayers.Format"
|
|
});
|