Luciad.Datamodels.DataPropertyPath.Builder Class Reference

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

Inheritance diagram for Luciad.Datamodels.DataPropertyPath.Builder:

Public Member Functions
Luciad.Datamodels.DataPropertyPath	Build ()
	Build the data property path. More...
void	Dispose ()
Luciad.Datamodels.DataPropertyPath.Builder	OriginType (Luciad.Datamodels.DataType originType)
	Sets the type that the created path is associated to. More...
Luciad.Datamodels.DataPropertyPath.Builder	Property (Luciad.Datamodels.DataProperty property)
Luciad.Datamodels.DataPropertyPath.Builder	Property (string name)
	Sets the name of the next property in the path. More...

Detailed Description

Builder that allows DataPropertyPath instances to be created.

Typical usage would be create a DataPropertyPath::Builder using DataPropertyPath::newBuilder, specifying the origin DataType. Then specify the properties to follow and finally build() the data property path. The following snippet shows how this is done for a simple example data property path:

            return DataPropertyPath.NewBuilder()
                .OriginType(dataType)
                .Property(someProperty)
                .Build();

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::DataPropertyPath::Builder.

Member Function Documentation

Build()

Luciad.Datamodels.DataPropertyPath Luciad.Datamodels.DataPropertyPath.Builder.Build ( )

inline

Build the data property path.

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

luciad::LogicException

If not all mandatory parameters are set.

the data property path.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::DataPropertyPath::Builder::build.

Dispose()

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

inline

OriginType()

Luciad.Datamodels.DataPropertyPath.Builder Luciad.Datamodels.DataPropertyPath.Builder.OriginType ( Luciad.Datamodels.DataType  originType )

inline

Sets the type that the created path is associated to.

Calling this function is mandatory. You have to call this method before setting any property.

originType

the type that the created path is associated to.

this builder.

luciad::LogicException

if multiple origin type are set.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::DataPropertyPath::Builder::originType.

Property() [1/2]

Luciad.Datamodels.DataPropertyPath.Builder Luciad.Datamodels.DataPropertyPath.Builder.Property ( Luciad.Datamodels.DataProperty  property )

inline

Property() [2/2]

Luciad.Datamodels.DataPropertyPath.Builder Luciad.Datamodels.DataPropertyPath.Builder.Property ( string  name )

inline

Sets the name of the next property in the path.

name

the name of the next property in the path.

this builder.

luciad::InvalidArgumentException

if no such property exists in the type that the path currently refers to.

luciad::LogicException

If no origin type has been set.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::DataPropertyPath::Builder::property.