FDO .NET API Reference Feature Data Objects
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

OSGeo::FDO::Xml::XmlFeatureFlags Class Reference

Inherits OSGeo::FDO::Xml::XmlFlags.

Inheritance diagram for OSGeo::FDO::Xml::XmlFeatureFlags:

[legend]
List of all members.

Detailed Description

XmlFeatureFlags extends XmlFlags to specify flags specific to feature serialization.

Remarks:
The Error Levels inherited from XmlFlags 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:
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.


Public Types

enum  ConflictOption {
  ConflictOption_Add = FdoXmlFeatureFlags::ConflictOption_Add,
  ConflictOption_Update = FdoXmlFeatureFlags::ConflictOption_Update,
  ConflictOption_Skip = FdoXmlFeatureFlags::ConflictOption_Skip
}
 The XmlFeatureFlags::ConflictOption specifies how to handle features that are already in the DataStore, when Deserializing:. More...

Public Member Functions

__property System::String * get_CollectionName ()
 Gets the feature collection element name.
__property System::String * get_CollectionUri ()
 Gets the feature collection element URI.
__property OSGeo::FDO::Xml::XmlFeatureFlags::ConflictOption get_Conflictoption ()
 Get the current option for handling feature already in the connection datastore.
__property System::String * get_DefaultNamespace ()
 Gets the default namespace.
__property System::String * get_GmlIdPrefix ()
 Gets the current GML ID prefix.
__property System::String * get_MemberName ()
 Gets the feature member element name.
__property System::String * get_MemberUri ()
 Gets the feature member element URI.
__property OSGeo::FDO::Common::StringCollectionget_Namespaces ()
 Gets all namespaces that have been set for schemaLocation by SetSchemaLocation().
__property System::String * get_SchemaLocation (System::String *schemaNamespace)
 Gets the schema location for the specified namespace.
__property System::Boolean get_WriteCollection ()
 Gets the write feature collection flag.
__property System::Boolean get_WriteMember ()
 Gets the write feature member flag.
__property System::Void set_CollectionName (System::String *name)
 Sets the name for the feature collection element to wrap around serialized features. The initial value is 'FeatureCollection'.
__property System::Void set_CollectionUri (System::String *uri)
 Sets the URI for the feature collection element to wrap around serialized features. The initial value is 'http://www.opengis.net/gml'.
__property System::Void set_Conflictoption (OSGeo::FDO::Xml::XmlFeatureFlags::ConflictOption conflictOption)
 Sets the current option for handling features already in the connection datastore.
__property System::Void set_DefaultNamespace (System::String *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.
__property System::Void set_GmlIdPrefix (System::String *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).
__property System::Void set_MemberName (System::String *name)
 Sets the name for the feature member element to wrap around each serialized feature. The initial value is 'featureMember'.
__property System::Void set_MemberUri (System::String *uri)
 Sets the URI for the feature member element to wrap around each serialized feature. The initial value is 'http://www.opengis.net/gml'.
__property System::Void set_SchemaLocation (System::String *schemaNamespace, System::String *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.
__property System::Void set_WriteCollection (System::Boolean writeMember)
 Sets the write feature collection flag. This flag is initially set to true.
__property System::Void set_WriteMember (System::Boolean writeMember)
 Sets the write feature member flag. This flag is initially set to true.
 XmlFeatureFlags (System::String *location, OSGeo::FDO::Xml::XmlFlags::ErrorLevel errorLevel, System::Boolean nameAdjust, OSGeo::FDO::Xml::XmlFeatureFlags::ConflictOption conflictOption)
 Constructs an XmlFeatureFlags object.
 XmlFeatureFlags (System::String *location, OSGeo::FDO::Xml::XmlFlags::ErrorLevel errorLevel, System::Boolean nameAdjust)
 Constructs an XmlFeatureFlags object.
 XmlFeatureFlags (System::String *location, OSGeo::FDO::Xml::XmlFlags::ErrorLevel errorLevel)
 Constructs an XmlFeatureFlags object.
 XmlFeatureFlags (System::String *location)
 Constructs an XmlFeatureFlags object.
 XmlFeatureFlags ()
 Constructs an XmlFeatureFlags object.

Protected Member Functions

virtual System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Member Enumeration Documentation

enum OSGeo::FDO::Xml::XmlFeatureFlags::ConflictOption
 

The XmlFeatureFlags::ConflictOption specifies how to handle features that are already in the DataStore, when Deserializing:.

Parameters:
ConflictOption_Add just add new features to the FDO DataStore. If a feature already exists, an exception is thrown.
ConflictOption_Update Update the feature if it already exists, add it if it doesn't exist. This is the slowest option, since the feature must be queried from the DataStore before it is inserted or updated.
ConflictOption_Skip just add new features. Silently skip features already in the DataStore.
Enumeration values:
ConflictOption_Add 
ConflictOption_Update 
ConflictOption_Skip 

Constructor & Destructor Documentation

OSGeo::FDO::Xml::XmlFeatureFlags::XmlFeatureFlags  ) 
 

Constructs an XmlFeatureFlags object.

OSGeo::FDO::Xml::XmlFeatureFlags::XmlFeatureFlags System::String *  location  ) 
 

Constructs an XmlFeatureFlags object.

Parameters:
location See XmlFlags::Create()

OSGeo::FDO::Xml::XmlFeatureFlags::XmlFeatureFlags System::String *  location,
OSGeo::FDO::Xml::XmlFlags::ErrorLevel  errorLevel
 

Constructs an XmlFeatureFlags object.

Parameters:
location See XmlFlags::Create()
errorLevel See XmlFlags::Create()

OSGeo::FDO::Xml::XmlFeatureFlags::XmlFeatureFlags System::String *  location,
OSGeo::FDO::Xml::XmlFlags::ErrorLevel  errorLevel,
System::Boolean  nameAdjust
 

Constructs an XmlFeatureFlags object.

Parameters:
location See XmlFlags::Create()
errorLevel See XmlFlags::Create()
nameAdjust See XmlFlags::Create()

OSGeo::FDO::Xml::XmlFeatureFlags::XmlFeatureFlags System::String *  location,
OSGeo::FDO::Xml::XmlFlags::ErrorLevel  errorLevel,
System::Boolean  nameAdjust,
OSGeo::FDO::Xml::XmlFeatureFlags::ConflictOption  conflictOption
 

Constructs an XmlFeatureFlags object.

Parameters:
location See XmlFlags::Create()
errorLevel See XmlFlags::Create()
nameAdjust See XmlFlags::Create()
conflictOption Conflict option to apply to pre-existing features, when deserializing features into an FDO datastore.

Member Function Documentation

__property System::String* OSGeo::FDO::Xml::XmlFeatureFlags::get_CollectionName  ) 
 

Gets the feature collection element name.

Returns:
Returns System::String*.

__property System::String* OSGeo::FDO::Xml::XmlFeatureFlags::get_CollectionUri  ) 
 

Gets the feature collection element URI.

Returns:
Returns the URI.

__property OSGeo ::FDO ::Xml ::XmlFeatureFlags::ConflictOption OSGeo::FDO::Xml::XmlFeatureFlags::get_Conflictoption  ) 
 

Get the current option for handling feature already in the connection datastore.

Returns:
Returns the current conflict option.

__property System::String* OSGeo::FDO::Xml::XmlFeatureFlags::get_DefaultNamespace  ) 
 

Gets the default namespace.

Returns:
Returns the default namespace.

__property System::String* OSGeo::FDO::Xml::XmlFeatureFlags::get_GmlIdPrefix  ) 
 

Gets the current GML ID prefix.

Returns:
Returns System::String

__property System::String* OSGeo::FDO::Xml::XmlFeatureFlags::get_MemberName  ) 
 

Gets the feature member element name.

Returns:
Returns System::String*.

__property System::String* OSGeo::FDO::Xml::XmlFeatureFlags::get_MemberUri  ) 
 

Gets the feature member element URI.

Returns:
Returns System::String*

__property OSGeo ::FDO ::Common ::StringCollection* OSGeo::FDO::Xml::XmlFeatureFlags::get_Namespaces  ) 
 

Gets all namespaces that have been set for schemaLocation by SetSchemaLocation().

Returns:
Returns all namespaces that have been set for schemaLocation.

__property System::String* OSGeo::FDO::Xml::XmlFeatureFlags::get_SchemaLocation System::String *  schemaNamespace  ) 
 

Gets the schema location for the specified namespace.

Parameters:
schemaNamespace Namespace of which the schema location is to be retrieved. Like "http://www.opengis.net/wfs"
Returns:
Returns the URL indicating the schema location.

__property System::Boolean OSGeo::FDO::Xml::XmlFeatureFlags::get_WriteCollection  ) 
 

Gets the write feature collection flag.

Returns:
Returns the write feature collection flag.

__property System::Boolean OSGeo::FDO::Xml::XmlFeatureFlags::get_WriteMember  ) 
 

Gets the write feature member flag.

Returns:
Returns the write feature member flag.

virtual System::Void OSGeo::FDO::Xml::XmlFeatureFlags::ReleaseUnmanagedObject  )  [protected, virtual]
 

DOXYGEN-IGNORE

Reimplemented from OSGeo::FDO::Xml::XmlFlags.

__property System::Void OSGeo::FDO::Xml::XmlFeatureFlags::set_CollectionName System::String *  name  ) 
 

Sets the name for the feature collection element to wrap around serialized features. The initial value is 'FeatureCollection'.

Parameters:
name Input the name. If NULL or blank, the name reverts back to the initial value.

__property System::Void OSGeo::FDO::Xml::XmlFeatureFlags::set_CollectionUri System::String *  uri  ) 
 

Sets the URI for the feature collection element to wrap around serialized features. The initial value is 'http://www.opengis.net/gml'.

Parameters:
uri Input the URI. If NULL or blank, the URI reverts back to the initial value.

__property System::Void OSGeo::FDO::Xml::XmlFeatureFlags::set_Conflictoption OSGeo::FDO::Xml::XmlFeatureFlags::ConflictOption  conflictOption  ) 
 

Sets the current option for handling features already in the connection datastore.

Parameters:
conflictOption Specifies how feaures, already in the datastore, are handled.

__property System::Void OSGeo::FDO::Xml::XmlFeatureFlags::set_DefaultNamespace System::String *  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.

Parameters:
defaultNamespace Default namespace.

__property System::Void OSGeo::FDO::Xml::XmlFeatureFlags::set_GmlIdPrefix System::String *  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).

Parameters:
prefix Input the GML ID Prefix

__property System::Void OSGeo::FDO::Xml::XmlFeatureFlags::set_MemberName System::String *  name  ) 
 

Sets the name for the feature member element to wrap around each serialized feature. The initial value is 'featureMember'.

Parameters:
name Input the name. If NULL or blank, the URI defaults to the name of the feature collection element's sub-element. If this sub-element cannot be determined then the name defaults to the initial value

__property System::Void OSGeo::FDO::Xml::XmlFeatureFlags::set_MemberUri System::String *  uri  ) 
 

Sets the URI for the feature member element to wrap around each serialized feature. The initial value is 'http://www.opengis.net/gml'.

Parameters:
uri Input the URI. If NULL or blank, the URI defaults to the URI of the feature collection element's sub-element. If this sub-element cannot be determined then the URI defaults to the initial value

__property System::Void OSGeo::FDO::Xml::XmlFeatureFlags::set_SchemaLocation System::String *  schemaNamespace,
System::String *  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.

Parameters:
schemaNamespace Namespace of which the schema location is to be set. Like "http://www.opengis.net/wfs" for wfs namespace.
schemaLocation Standard URL indicating the schema location, like "http://schemas.opengeospatial.net/wfs/1.0.0/WFS-basic.xsd" for wfs namespace.

__property System::Void OSGeo::FDO::Xml::XmlFeatureFlags::set_WriteCollection System::Boolean  writeMember  ) 
 

Sets the write feature collection flag. This flag is initially set to true.

Parameters:
writeMember Input true: The serialized features are wrapped in a GML FeatureCollection element. false: features are serialize without a wrapping collection element.

__property System::Void OSGeo::FDO::Xml::XmlFeatureFlags::set_WriteMember System::Boolean  writeMember  ) 
 

Sets the write feature member flag. This flag is initially set to true.

Parameters:
writeMember Input true: Each serialized feature is wrapped in a GML featureMember element. false: features are serialized without a wrapping member element. Normally, writeMember would only be set to false when writing values to a collection object property.

Comments or suggestions? Send us feedback.