Diffusion .NET Client Library
6.1.5
|
This factory provides mechanisms for building and serialising metadata. More...
Public Member Functions | |
IMDecimalStringBuilder | DecimalBuilder (string name) |
Create a new decimal field metadata builder. More... | |
IMStringBuilder | StringBuilder (string name) |
Create a new string field metadata builder. More... | |
IMRecordBuilder | RecordBuilder (string name) |
Creates a new record metadata builder. More... | |
IMRecord | Record (string name, params IMField[] fields) |
Creates a new record metadata definition comprising the supplied fields, each with single multiplicity. More... | |
IMIntegerStringBuilder | IntegerBuilder (string name) |
Create a new integer field metadata builder. More... | |
IMCustomStringBuilder | CustomBuilder (string name, string handler) |
Create a new custom field metadata builder. More... | |
IMContentBuilder | ContentBuilder (string name) |
Creates a new content metadata builder. More... | |
IMContent | Content (string name, params IMRecord[] records) |
Creates a new content metadata definition comprising the supplied record definitions, each with single multiplicity. More... | |
IMString | String (string name) |
Convenience method to build a string field metadata definition. More... | |
IMString | String (string name, string defaultValue) |
Convenience method to build a string field metadata definition with a default value. More... | |
IMDecimalString | Decimal (string name) |
Convenience method to build a decimal field metadata definition with default scale of 2. More... | |
IMDecimalString | Decimal (string name, string defaultValue) |
Convenience method to build a decimal field metadata definition with a default value and a scale of 2. More... | |
IMDecimalString | Decimal (string name, double defaultValue) |
Convenience method to build a decimal field metadata definition with a default value and a scale of 2. More... | |
IMDecimalString | Decimal (string name, decimal defaultValue) |
Convenience method to build a decimal field metadata definition with a default value and a scale of 2. More... | |
IMIntegerString | Integer (string name) |
Convenience method to build an integer field metadata definition. More... | |
IMIntegerString | Integer (string name, string defaultValue) |
Convenience method to build an integer field metadata definition with a supplied default value. More... | |
IMIntegerString | Integer (string name, int defaultValue) |
Convenience method to build an integer field metadata definition with a supplied default value. More... | |
IMIntegerString | Integer (string name, decimal defaultValue) |
Convenience method to build an integer field metadata definition with a supplied default value. More... | |
IMCustomString | CustomString (string name, string handlerClass) |
Convenience method to build a custom field metadata definition. More... | |
string | EncodeAsXml (IMNode metadata) |
Encode metadata as xml. More... | |
string | EncodeAsXml (IMNode metadata, bool format) |
Encode metadata as xml. More... | |
IMNode | DecodeFromXml (string xml) |
Parse metadata from xml. More... | |
This factory provides mechanisms for building and serialising metadata.
If metadata is to be used for topics then it is highly recommended that each top-level metadata occurrence has a unique name as this allows for certain optimisations like metadata caching.
An instance of the factory may be obtained using Diffusion.Metadata.
IMContent PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.Content | ( | string | name, |
params IMRecord[] | records | ||
) |
Creates a new content metadata definition comprising the supplied record definitions, each with single multiplicity.
name | The content definition name. |
records | An array of record definitions representing single occurrence record instances within the content in the order specified. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
IMContentBuilder PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.ContentBuilder | ( | string | name | ) |
Creates a new content metadata builder.
name |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
IMCustomStringBuilder PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.CustomBuilder | ( | string | name, |
string | handler | ||
) |
Create a new custom field metadata builder.
name | The field name. |
handler | The full handler class name. This must specify the name of a class available at the server which will be instantiated to handle the field. The class must implement the required CustomFieldHandler interface. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
IMCustomString PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.CustomString | ( | string | name, |
string | handlerClass | ||
) |
Convenience method to build a custom field metadata definition.
name | The field name. |
handlerClass | The full name of the handler class available at the server. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
IMDecimalString PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.Decimal | ( | string | name | ) |
Convenience method to build a decimal field metadata definition with default scale of 2.
name | The field name. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
IMDecimalString PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.Decimal | ( | string | name, |
string | defaultValue | ||
) |
Convenience method to build a decimal field metadata definition with a default value and a scale of 2.
name | The field name. |
defaultValue | The default value which must be a valid decimal number representation. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
IMDecimalString PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.Decimal | ( | string | name, |
double | defaultValue | ||
) |
Convenience method to build a decimal field metadata definition with a default value and a scale of 2.
name | The field name. |
defaultValue | The default value. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
IMDecimalString PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.Decimal | ( | string | name, |
decimal | defaultValue | ||
) |
Convenience method to build a decimal field metadata definition with a default value and a scale of 2.
name | The field name. |
defaultValue | The default value which must be a valid decimal number representation. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
IMDecimalStringBuilder PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.DecimalBuilder | ( | string | name | ) |
Create a new decimal field metadata builder.
name | The field name. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
IMNode PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.DecodeFromXml | ( | string | xml | ) |
Parse metadata from xml.
The xml may have been created using EncodeAsXml( IMNode ).
xml | A string containing an xml definition of metadata. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
string PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.EncodeAsXml | ( | IMNode | metadata | ) |
Encode metadata as xml.
Equivalent to calling EncodeAsXml( IMNode, bool ) with format=false
.
metadata | The top-level node with the metadata definition to encode. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
string PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.EncodeAsXml | ( | IMNode | metadata, |
bool | format | ||
) |
Encode metadata as xml.
metadata | The top-level node with the metadata definition to encode. |
format | Indicates whether the xml should be formatted. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
IMIntegerString PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.Integer | ( | string | name | ) |
Convenience method to build an integer field metadata definition.
name | The field name. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
IMIntegerString PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.Integer | ( | string | name, |
string | defaultValue | ||
) |
Convenience method to build an integer field metadata definition with a supplied default value.
name | The field name. |
defaultValue | The default value as a string. This must be a valid integer number representation. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
IMIntegerString PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.Integer | ( | string | name, |
int | defaultValue | ||
) |
Convenience method to build an integer field metadata definition with a supplied default value.
name | The field name. |
defaultValue | The default value. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
IMIntegerString PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.Integer | ( | string | name, |
decimal | defaultValue | ||
) |
Convenience method to build an integer field metadata definition with a supplied default value.
name | The field name. |
defaultValue | The default value. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
IMIntegerStringBuilder PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.IntegerBuilder | ( | string | name | ) |
Create a new integer field metadata builder.
name | The field name. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
IMRecord PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.Record | ( | string | name, |
params IMField[] | fields | ||
) |
Creates a new record metadata definition comprising the supplied fields, each with single multiplicity.
name | The record name. |
fields | The array of field metadata definitions each representing a single occurrence field within the record in the order supplied. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
IMRecordBuilder PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.RecordBuilder | ( | string | name | ) |
Creates a new record metadata builder.
name | The name of the record. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
IMString PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.String | ( | string | name | ) |
Convenience method to build a string field metadata definition.
name | The field name. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
IMString PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.String | ( | string | name, |
string | defaultValue | ||
) |
Convenience method to build a string field metadata definition with a default value.
name | The field name. |
defaultValue | The default value. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.
IMStringBuilder PushTechnology.ClientInterface.Client.Content.Metadata.IMetadataFactory.StringBuilder | ( | string | name | ) |
Create a new string field metadata builder.
name | The name of the field. |
Implemented in PushTechnology.ClientInterface.Client.Content.Metadata.Record.MetadataFactory.