Luciad.Datamodels.DataType.Builder Class Reference

Builder that allows DataType instances to be created. More...

Inheritance diagram for Luciad.Datamodels.DataType.Builder:

Public Member Functions
	Builder (Luciad.Datamodels.DataType.Builder other)
Luciad.Datamodels.DataType.Builder	AddAnnotation (Luciad.Datamodels.DataAnnotation annotation)
	The annotation to add to the data type under construction. More...
Luciad.Datamodels.DataType.Builder	AddAnnotation (Luciad.Datamodels.IDataAnnotationFactory annotationFactory)
	Adds an annotation factory that is invoked when build is called. More...
Luciad.Datamodels.DataType.Builder	AddProperty (Luciad.Datamodels.DataProperty property)
	The property to add to the data type under construction. More...
Luciad.Datamodels.DataType	Build ()
	Build the data type, including the properties and annotations that were added to this builder. More...
void	Dispose ()
Luciad.Datamodels.DataType.Builder	Name (string name)
	The name of the new data type. More...

Detailed Description

Builder that allows DataType instances to be created.

Typical usage would be create a DataType.Builder using DataType.NewBuilder, specifying the data type's name. Then add the necessary DataProperty(s) and finally build() the data type. The following snippet shows how this is done for a simple example data type:

            return DataType.NewBuilder()
            .Name("TestDataType")
            .AddProperty(someProperty)
            .AddProperty(geometryProperty)
            .AddAnnotation(new GeometryDataAnnotationFactory(geometryProperty))
            .Build();

Constructor & Destructor Documentation

Builder()

Luciad.Datamodels.DataType.Builder.Builder ( Luciad.Datamodels.DataType.Builder  other )

inline

Member Function Documentation

AddAnnotation() [1/2]

Luciad.Datamodels.DataType.Builder Luciad.Datamodels.DataType.Builder.AddAnnotation ( Luciad.Datamodels.DataAnnotation  annotation )

inline

The annotation to add to the data type under construction.

Parameters

annotation

the annotation to add to the data type under construction.

Returns

this builder.

Exceptions

System.ArgumentNullException

when a null value is passed.

AddAnnotation() [2/2]

Luciad.Datamodels.DataType.Builder Luciad.Datamodels.DataType.Builder.AddAnnotation ( Luciad.Datamodels.IDataAnnotationFactory  annotationFactory )

inline

Adds an annotation factory that is invoked when build is called.

The factory is provided with the type that is being built. This can be useful when the created annotation needs access to the type, for instance when the annotation requires a DataPropertyPath.

An example usage is:

    public sealed class GeometryDataAnnotationFactory : IDataAnnotationFactory
    {
        public GeometryDataAnnotationFactory(DataProperty property)
        {
            if (property == null)
            {
                throw new ArgumentNullException("GeometryDataAnnotationFactory does not accept null DataProperty instances in its constructor");
            }
 
            Property = property;
        }
 
        public DataAnnotation CreateAnnotation(DataType dataType)
        {
            return new GeometryDataAnnotation(DataPropertyPath.NewBuilder().OriginType(dataType).Property(Property).Build());
        }
 
        private readonly DataProperty Property;
    }

            var geometryProperty = DataProperty.NewBuilder().Name("geometry").ValueType(DataType.GeometryType).Build();
            var dataType = DataType.NewBuilder()
                                .Name("MyType")
                                .AddProperty(geometryProperty)
                                .AddAnnotation(new GeometryDataAnnotationFactory(geometryProperty))
                                .Build();

Parameters

annotationFactory

the factory object.

Returns

this builder.

Exceptions

System.ArgumentNullException

when a null value is passed.

AddProperty()

Luciad.Datamodels.DataType.Builder Luciad.Datamodels.DataType.Builder.AddProperty ( Luciad.Datamodels.DataProperty  property )

inline

The property to add to the data type under construction.

Parameters

property

the property to add to the data type under construction.

Returns

this builder.

Build()

Luciad.Datamodels.DataType Luciad.Datamodels.DataType.Builder.Build ( )

inline

Build the data type, including the properties and annotations that were added to this builder.

After calling this function, this builder should no longer be used.

Returns

the data type.

Exceptions

System.InvalidOperationException

If not all mandatory parameters are set.

Dispose()

void Luciad.Datamodels.DataType.Builder.Dispose ( )

inline

Name()

Luciad.Datamodels.DataType.Builder Luciad.Datamodels.DataType.Builder.Name ( string  name )

inline

The name of the new data type.

Calling this function is mandatory.

Parameters

name	name of the new data type.

Returns

this builder.