HierarchyHelper Class

Object hierarchy manipulation methods.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.HierarchyHelper
    CMS.DocumentEngine.DocumentHierarchyHelper

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 8.2.23

Syntax

public class HierarchyHelper

The HierarchyHelper type exposes the following members.

Constructors

	Name	Description
Protected method	HierarchyHelper(ExportObjectSettings)	Default constructor for inheritance
Protected method	HierarchyHelper(ExportObjectSettings, GeneralizedInfo)	Creates new instance of CMSHierarchyHelper which can be used to serialize given object.

Methods

	Name	Description
Protected method Static member	AddTranslation	Adds given ID into the translation table to correct list according to objectType
Protected method Static member	AppendNode	Appends hierarchy node to the result.
Protected method Static member	CacheExportResult	Puts the result of the export to the cache (including TranslationHelper if present).
Protected method Static member	CallEndCollection(TraverseObjectSettings, String)	Calls given delegate with required parameters if delegate is not null.
Protected method Static member	CallEndCollection(TraverseObjectSettings, String, Boolean)	Calls given delegate with required parameters if delegate is not null.
Protected method Static member	CallItemCallback	Calls item callback if exists.
Protected method Static member	CallObjectCallback	Calls object callback if exists.
Protected method Static member	CallStartCollection(TraverseObjectSettings, String)	Calls given delegate with required parameters if delegate is not null.
Protected method Static member	CallStartCollection(TraverseObjectSettings, String, Boolean)	Calls given delegate with required parameters if delegate is not null.
Protected method	DataAvailable	Returns true if the data can be exported
Protected method Static member	ExportCategoryObjects	Exports categories data to given StringBuilder object.
Public method	ExportObject()	Returns XML representation of given instance of info object.
Public method Static member	ExportObject(ExportObjectSettings, BaseInfo)	Returns XML representation of given instance of info object.
Protected method	ExportObjectData	Exports the object data
Protected method Static member	GetCompositeID	Returns object ID even if it is composed out of multiple columns.
Protected method Static member	GetListOfColumns	Returns list of supported columns/properties
Protected method Static member	GetMetadata	Returns metadata for given object according to export settings.
Protected method	GetMetadataSource	Gets the metadata source object
Protected method Static member	GetResultFromCache	Tries find exported data and TranslationHelper in cache.
Protected method	GetSyndicationItem	Gets the syndication item created from current object
Protected method Static member	LoadDataSetFromJSON	Recursively loads dataset from JSON deserialized object. Returns list of fields contained in the JSON data (for update object purposes).
Public method Static member	LoadObjectFromDataRow	Loads an GeneralizedInfo with values from given DataRow.
Public method Static member	LoadObjectFromDataSet(GeneralizedInfo, DataSet, Boolean, List<String>, List<String>)	Loads object data including collection from a given data set.
Protected method Static member	LoadObjectFromDataSet(GeneralizedInfo, DataSet, Boolean, Int32, List<String>, List<String>)	Loads object data including collection from a given data set.
Public method Static member	LoadObjectFromJSON	Loads objects data including collection from a given XML representation.
Public method Static member	LoadObjectFromXML	Loads objects data including collection from a given XML representation (root of the xml has to be ClassTableName of given object).
Protected method	ProcessArraySeparatorMethod	Handles array separator of the collection export.
Protected method	ProcessEndCollectionMethod	Handles end of the collection export.
Protected method	ProcessIDMethod	Handles FK ID (can be used to fill translation helper for example).
Protected method	ProcessItemMethod	Handles FK ID (can be used to fill translation helper for example).
Protected method	ProcessObjectMethod	Handles export to required format.
Protected method	ProcessStartCollectionMethod	Handles start of the collection export.
Protected method Static member	ProcessTranslations	Fills translation helper with data from hashtable and appends translations to the result if needed.
Protected method Static member	TraverseObjectCollection	Exports given child collection.
Public method Static member	TraverseObjectStructure	Goes through the object structure and calls given delegates.
Protected method Static member	WrapResult	Wraps final result into root if needed.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Protected property	ResultBuilder	Result builder
Protected property	Settings	Settings