[This is preliminary documentation and is subject to change.]
Summary description for BaseInformationEntity.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public abstract class BaseInformationEntity
Public MustInherit Class BaseInformationEntity
public ref class BaseInformationEntity abstract
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | BaseInformationEntity(String) |
Class Constructor.
|
| AddAdditionalAttributes(Boolean, DataSet) |
Add the additional attributes to this Entity and any children.
|
| AddChild(BaseInformationEntity) |
Add a child Entity to this.
|
| AddDefaultAttributes(Boolean, DataSet) |
Use the information entity tagTypeList to add default values from the defaultDataset
into this _dataset.
A default value will be added if:
overWriteExistingValue is true and a default value exists.
or:
overWriteExistingValue is false and the default value exists and this _dataset either does
not contain the default tag or the default tag has a zero-length value.
All child Entities are also processed.
|
 | Children |
Get the Entity child list in the Information Model.
|
| ChildrenWithUniqueTagFoundIn(AttributeSet) | |
| ConsoleDisplay()()() |
Display this Entity to the Console - useful when debugging.
|
| CopyAdditionalAttributes(AttributeSet) |
Copy the defined Additional Attributes from the local additional attributes to the given
dataset.
|
| CopyFrom(AttributeSet) |
Copy from the given source Dataset into the local Dataset as defined by the
default Tag Type list.
|
| CopyFrom(TagTypeList, AttributeSet) |
Copy from the given source Dataset into the local Dataset as defined by the
given Tag Type list.
|
| CopyTo(AttributeSet) |
Copy from the local Dataset into the given destination Dataset as defined by the
default Tag Type list.
|
| CopyTo(TagTypeList, AttributeSet) |
Copy from the local Dataset into the given destination Dataset as defined by the
given Tag Type list.
|
| CopyUniqueTagTo(AttributeSet) |
Copy the attribute with a Unique tag from the local Dataset into the given destination Dataset.
|
| DataSet |
Get the local DataSet used to store the Entity attribute values.
|
| Dump(String) |
Dump this Entity to a String - useful when debugging.
|
| Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
 | Finalize()()() | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode()()() | Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) |
| GetSpecificCharacterSet()()() |
Try to get the Specific Character Set attribute stored in the dataset of the IE.
|
| GetType()()() | Gets the Type of the current instance. (Inherited from Object.) |
| IsFoundIn(AttributeSet) |
Check if the given match dataset is found in the local dataset using the default Tag Type list.
A check is made to see if all the attributes in the given match dataset are present in the local
dataset.
|
| IsFoundIn(TagTypeList, AttributeSet) |
Check if the given match dataset is found in the local dataset using the given Tag Type list.
A check is made to see if all the attributes in the given match dataset are present in the local
dataset.
|
| IsUniqueTagFoundIn(AttributeSet) |
Check if the Unique Tag as defined in the local Tag Type list is present in the given match dataset.
|
| Level |
Get the Entity Level in the Information Model.
|
| MemberwiseClone()()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Parent |
Get the Entity parent in the Information Model.
|
| SetDefaultTagTypeList()()() |
Implement is any sub-classes - define the default Tag Type list.
|
| TagTypeList |
Set/Get the Tag Type list used to interogate the Entity.
|
| ToString()()() | Returns a String that represents the current Object. (Inherited from Object.) |
| UniversalMatch(TagTypeList) |
Check if a Universal Match is possible on the local dataset using the Tag Type list given.
|
Inheritance Hierarchy
