C# Class Sfm2Xml.ClsHierarchyEntry

This class implements the data structure for the "hierarchy" mapping element. This element contains any number of "level" elements which define a hierarchy level. Attributes of "level" are: - name : (R) the name of this type - partOf : (R) this is a list of "levels" that this one can belong to. - beginFields : (R) this is a list of "field"-"sfm" values that defines which fields can be used to start a new "level". - additionalFields : (O) this is a list of "field"-"sfm" values that are allowed for this type. - multiFields : (O) this is a list of "field"-"sfm" values that can have multiple entries at this current level. - uniqueFields: (O) this is a list of "field"-"sfm" values that can only be used one time in each entry. It is used to override allowing multiple begin fields that are different to be combined in a given field/object.
Show file Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method Description
AddAdditionalField ( string sfm ) : bool
AddAncestor ( string ancestor ) : bool
AddBeginField ( string sfm ) : bool
AddMultiField ( string sfm ) : bool
AddUniqueField ( string sfm ) : bool
AdditionalFieldsContains ( string sfm ) : bool
BeginFieldsContains ( string sfm ) : bool
ClsHierarchyEntry ( ) : System
ClsHierarchyEntry ( string name ) : System
ClsHierarchyEntry ( string name, string partof, string beginFields, string additionalFields, string multiFields, string uniqueFields ) : System
ContainsAncestor ( string ancestor ) : bool
FindRootFromHash ( Hashtable hierarchy ) : string
MultiFieldsContains ( string sfm ) : bool
ReadXmlNode ( System Level ) : bool
RemoveAdditionalField ( string sfm ) : void
RemoveAncestor ( string ancestor ) : void
RemoveBeginField ( string sfm ) : void
RemoveMultiField ( string sfm ) : void
RemoveUniqueField ( string sfm ) : void
ToString ( ) : string
ToXmlString ( ) : string
UniqueFieldsContains ( string sfm ) : bool
UsesSFM ( string sfm ) : bool

Protected Methods

Method Description
TestMethodAddAncestors ( ICollection names ) : void

Private Methods

Method Description
Init ( ) : void
SplitString ( string xyz, Hashtable &list ) : void

Method Details

AddAdditionalField() public method

public AddAdditionalField ( string sfm ) : bool
sfm string
return bool

AddAncestor() public method

public AddAncestor ( string ancestor ) : bool
ancestor string
return bool

AddBeginField() public method

public AddBeginField ( string sfm ) : bool
sfm string
return bool

AddMultiField() public method

public AddMultiField ( string sfm ) : bool
sfm string
return bool

AddUniqueField() public method

public AddUniqueField ( string sfm ) : bool
sfm string
return bool

AdditionalFieldsContains() public method

public AdditionalFieldsContains ( string sfm ) : bool
sfm string
return bool

BeginFieldsContains() public method

public BeginFieldsContains ( string sfm ) : bool
sfm string
return bool

ClsHierarchyEntry() public method

public ClsHierarchyEntry ( ) : System
return System

ClsHierarchyEntry() public method

public ClsHierarchyEntry ( string name ) : System
name string
return System

ClsHierarchyEntry() public method

public ClsHierarchyEntry ( string name, string partof, string beginFields, string additionalFields, string multiFields, string uniqueFields ) : System
name string
partof string
beginFields string
additionalFields string
multiFields string
uniqueFields string
return System

ContainsAncestor() public method

public ContainsAncestor ( string ancestor ) : bool
ancestor string
return bool

FindRootFromHash() public static method

public static FindRootFromHash ( Hashtable hierarchy ) : string
hierarchy System.Collections.Hashtable
return string

MultiFieldsContains() public method

public MultiFieldsContains ( string sfm ) : bool
sfm string
return bool

ReadXmlNode() public method

public ReadXmlNode ( System Level ) : bool
Level System
return bool

RemoveAdditionalField() public method

public RemoveAdditionalField ( string sfm ) : void
sfm string
return void

RemoveAncestor() public method

public RemoveAncestor ( string ancestor ) : void
ancestor string
return void

RemoveBeginField() public method

public RemoveBeginField ( string sfm ) : void
sfm string
return void

RemoveMultiField() public method

public RemoveMultiField ( string sfm ) : void
sfm string
return void

RemoveUniqueField() public method

public RemoveUniqueField ( string sfm ) : void
sfm string
return void

TestMethodAddAncestors() protected method

protected TestMethodAddAncestors ( ICollection names ) : void
names ICollection
return void

ToString() public method

public ToString ( ) : string
return string

ToXmlString() public method

public ToXmlString ( ) : string
return string

UniqueFieldsContains() public method

public UniqueFieldsContains ( string sfm ) : bool
sfm string
return bool

UsesSFM() public method

public UsesSFM ( string sfm ) : bool
sfm string
return bool