EWSoftware.PDI Namespace Documentation
Base
This abstract class is used as the base class for all other properties
Definition
Namespace: EWSoftware.PDI.Properties
Assembly: EWSoftware.PDI.Data (in EWSoftware.PDI.Data.dll) Version: 2023.1.2.0
Assembly: EWSoftware.PDI.Data (in EWSoftware.PDI.Data.dll) Version: 2023.1.2.0
C#
public abstract class BaseProperty : PDIObjectVB
Public MustInherit Class BaseProperty
Inherits PDIObjectC++
public ref class BaseProperty abstract : public PDIObjectF#
[<AbstractClassAttribute>]
type BaseProperty =
class
inherit PDIObject
end- Derived
Remarks
It implements functionality common to all properties. It also provides ToString methods
used to convert the instance to a format suitable for writing to a PDI data stream.
Constructors
| BaseProperty | Constructor. By default, it uses 7-bit ASCII encoding for the value, and the value type or location is determined from the DefaultValueLocation property. |
Properties
| CharacterSet | This is used to set or get the character set used for the value |
| CustomParameters | This property is used to set or get a string containing custom parameters that are not part of the specification. These are usually prefixed with "X-" to indicate an extension. |
| DefaultEncoding | This is used for the default text encoding when reading and writing properties with a non-ASCII CHARSET parameter. |
| DefaultValueLocation | Derived classes should override this to define the default data type/location to use if a VALUE parameter is not specified. |
| EncodedValue | This is used to set or get the value of the property in its encoded string form representing how it will be read from or written to the PDI data stream (i.e. Base 64, Quoted-Printable, etc). |
| EncodingMethod | Set or get the encoding method for this property's value as a value in the EncodingType enumeration. |
| EncodingString | Set or get the encoding method for this property's value as a string |
| Group | The group to which this property belongs |
| Language | This is used to set or get the language used for the value |
| PropertyId | This is used to get or set the property ID for the value |
| Tag | This read-only property must be specified to define the tag used for the property (i.e. FN, N, ADR, etc). |
| Value | This is used to set or get the value of the property in its unencoded string form |
| ValueLocation | The value (data) type or location of this property's value |
| Version |
This is overridden to enforce the correct encoding type when the version changes
(Overrides PDIObjectVersion) |
| VersionsSupported |
All objects derived from this class must implement this to indicate the specification versions with
which they can be used.
(Inherited from PDIObject) |
Methods
| Clone |
This must be overridden to allow cloning of a PDI object
(Inherited from PDIObject) |
| Clone(PDIObject) |
This is overridden to allow copying values from the specified PDI object into the instance
(Overrides PDIObjectClone(PDIObject)) |
| Decode | This method is used to decode a value read in from a PDI data stream |
| DeserializeParameters | This is used to deserialize parameter values from a string collection |
| Encode | This method is used to encode a value for output to a PDI data stream |
| Equals |
This is overridden to allow proper comparison of property objects
(Overrides ObjectEquals(Object)) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode |
Get a hash code for the property object
(Overrides ObjectGetHashCode) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| SerializeCharacterSet | This is called to serialize the CHARSET parameter if necessary |
| SerializeCustomParameters | This is called to serialize any custom parameters if necessary |
| SerializeEncoding | This is called to serialize the ENCODING parameter if necessary |
| SerializeLanguage | This is called to serialize the LANGUAGE parameter if necessary |
| SerializeParameters | This method can be overridden to customize how the parameters are appended to the property when being serialized to a PDI data stream. |
| SerializePropertyId | This is called to serialize the PID parameter if necessary |
| SerializeValueLocation | This is called to serialize the value location parameter if necessary |
| ToString |
This is overridden to convert the instance to a string
(Overrides ObjectToString) |
| ToString(StringBuilder) | This is used to convert the property instance to a format suitable for writing to a PDI data stream |
| ValueOrStringEmpty | A simple helper method that will return String.Empty if the specified string value is null. If not null, it returns the string value. |
| WriteToStream | This is a helper method that converts a property to its string form and writes it to the given text writer. |