FDO API Reference

Feature Data Objects

FdoXmlFeatureFlags Class Reference

#include <FeatureFlags.h>

Inherits FdoXmlFlags.

Inheritance diagram for FdoXmlFeatureFlags:

[legend]List of all members.

---

Detailed Description

FdoXmlFeatureFlags extends FdoXmlFlags to specify flags specific to feature serialization.

Remarks:

The Error Levels inherited from FdoXmlFlags take on the following meaning when applied to features. Suppose we have GML Document A that conforms to GML Schema A. If Document A is read into FDO and then written to Document B then the Error Levels applied to the Document A read have the following meaning:

• ErrorLevel_High: Document B will be structurally identical to Document A. Errors are issued if this cannot be guaranteed. Document B will have the exact same elements and attributes as Document A.
• ErrorLevel_Normal: There is no information loss. Document B contains all of the information from Document A and Document B conforms to Schema A. Errors are issued if this cannot be guaranteed. However, Documents A and B might not look exactly alike; some Document A elements may have an equivalent but different structure in Document B.
• ErrorLevel_Low: There can be information loss. Document B is a subset of Document A but still conforms to Schema A. Errors are issued if this cannot be guaranteed. Any Document A elements, not recognized by FDO, are discarded on read.
• ErrorLevel_VeryLow: FDO does a best effort read of Document A and write of Document B. There is no guarantee that Document B will look anything like Document A or that Document B will conform to Schema A.

The above assumes that FDO is not provided the GML form of Schema A when writing Document B. For example, supposed that FDO can write a Schema A conformant Document B only when supplied the GML version of Schema A. FDO will still generate errors and fail to read Document A under ErrorLevel_Low.

Definition at line 58 of file FeatureFlags.h.

Public Types
enum	ConflictOption { ConflictOption_Add, ConflictOption_Update, ConflictOption_Skip }
	The FdoXmlFeatureFlags::ConflictOption specifies how to handle features that are already in the DataStore, when Deserializing:. More...
Public Member Functions
virtual FDO_API FdoString *	GetCollectionName () const
	Gets the feature collection element name.
virtual FDO_API FdoString *	GetCollectionUri () const
	Gets the feature collection element URI.
virtual FDO_API ConflictOption	GetConflictOption () const
	Get the current option for handling feature already in the connection datastore.
virtual FDO_API FdoString *	GetDefaultNamespace ()
	Gets the default namespace.
virtual FDO_API FdoString *	GetGmlIdPrefix () const
	Gets the current GML ID prefix.
virtual FDO_API FdoString *	GetMemberName () const
	Gets the feature member element name.
virtual FDO_API FdoString *	GetMemberUri () const
	Gets the feature member element URI.
virtual FDO_API FdoStringCollection *	GetNamespaces ()
	Gets all namespaces that have been set for schemaLocation by SetSchemaLocation().
virtual FDO_API FdoString *	GetSchemaLocation (FdoString *nameSpace)
	Gets the schema location for the specified namespace.
virtual FDO_API FdoBoolean	GetWriteCollection () const
	Gets the write feature collection flag.
virtual FDO_API FdoBoolean	GetWriteMember () const
	Gets the write feature member flag.
virtual FDO_API void	SetCollectionName (FdoString *name)
	Sets the name for the feature collection element to wrap around serialized features. The initial value is 'FeatureCollection'.
virtual FDO_API void	SetCollectionUri (FdoString *uri)
	Sets the URI for the feature collection element to wrap around serialized features. The initial value is 'http://www.opengis.net/gml'.
virtual FDO_API void	SetConflictOption (ConflictOption conflictOption)
	Sets the current option for handling features already in the connection datastore.
virtual FDO_API void	SetDefaultNamespace (FdoString *defaultNamespace)
	Sets the default namespace which defines all feature/object types found in the input feature reader which is to be serialized. The user is also supposed to set the schema location for this namespace.
virtual FDO_API void	SetGmlIdPrefix (FdoString *prefix)
	Sets the GML ID prefix for writing features. This prefix is prepended to the gml:id value for each feature. When features from different FDO Datastores are serialized to the same GML document, it is recommended that a different GML ID prefix be used for each Datastore, to ensure that the gml:id values in the GML document are unique. The initial value is L"" (no prefix).
virtual FDO_API void	SetMemberName (FdoString *name)
	Sets the name for the feature member element to wrap around each serialized feature. The initial value is 'featureMember'.
virtual FDO_API void	SetMemberUri (FdoString *uri)
	Sets the URI for the feature member element to wrap around each serialized feature. The initial value is 'http://www.opengis.net/gml'.
virtual FDO_API void	SetSchemaLocation (FdoString *nameSpace, FdoString *schemaLocation)
	Sets the schema locations for writing features. The output GML must have schema definition for all its referenced namespaces, e.g, gml namespace, wfs namespace, user defined namespace. There are default values for gml namespace schema location and wfs namespace schema location, so the user doesn't need to set locations for those two namespaces. But the user can still set values to override the default values. The user could call this function multiple times to set schema location for multiple namespace.
virtual FDO_API void	SetWriteCollection (FdoBoolean writeCollection)
	Sets the write feature collection flag. This flag is initially set to true.
virtual FDO_API void	SetWriteMember (FdoBoolean writeMember)
	Sets the write feature member flag. This flag is initially set to true.
Static Public Member Functions
static FDO_API FdoXmlFeatureFlags *	Create (FdoString *url=L"fdo.osgeo.org/schemas/feature", ErrorLevel errorLevel=ErrorLevel_Normal, FdoBoolean nameAdjust=true, ConflictOption conflictOption=ConflictOption_Add)
	Constructs an FdoXmlFeatureFlags object.
Protected Member Functions
	FdoXmlFeatureFlags (FdoString *url, ErrorLevel errorLevel, FdoBoolean nameAdjust, ConflictOption conflictOption)
	FdoXmlFeatureFlags ()
virtual	~FdoXmlFeatureFlags ()

---

The documentation for this class was generated from the following file:

• FeatureFlags.h

---

Comments or suggestions? Send us feedback.