Grooper.Core.ClassifyMethod

Classify Methods define classification mechanisms which are used in Content Models.


Inherits from: Grooper.EmbeddedObject

Constructors

Signature Description
New (Owner As ConnectedObject)
Parameters
Owner
          Type: ConnectedObject
          

Fields

Field Name Field Type Description
Database As Grooper.GrooperDb Grooper.GrooperDb

Properties

Property Name Property Type Description
HasReferenceProperties System.Boolean Returns true if the object has properties which reference Grooper Node objects.
IsEmpty System.Boolean Returns true if all properties with a ViewableAttribute are set to their default value.
IsWriteable System.Boolean Returns true if the object is writable, or false if it is not.
Owner Grooper.ConnectedObject Returns the node that owns the connected object, if any.
OwnerNode Grooper.GrooperNode Returns the node that owns the connected object, if any.
Root Grooper.GrooperRoot Returns the root node

Methods

Method Name Description
ClassifyFolder(Folder As BatchFolder, Scope As ContentType, Level As ClassificationLevel) As ContentTypeCandidateList
Parameters
Folder
          Type: BatchFolder
          
 
Scope
          Type: ContentType
          
 
Level
          Type: ClassificationLevel
          
ClassifyPage(Page As BatchPage, Scope As ContentType) As PageTypeCandidateList
Parameters
Page
          Type: BatchPage
          
 
Scope
          Type: ContentType
          
ClearCache()
ComparePage(pt As PageType, Features As FeatureDictionary) As Double
Parameters
pt
          Type: PageType
          
 
Features
          Type: FeatureDictionary
          
ExtractFeatures(Page As IPage) As FeatureDictionary
Parameters
Page
          Type: IPage
          
GetProperties() As PropertyDescriptorCollection
GetReferences() As List(Of GrooperNode) Returns a list of GrooperNode objects referenced in the properties of this object.
IsPropertyEnabled(PropertyName As String) As Nullable(Of Boolean) Defines whether a property is currently enabled.
Parameters
PropertyName
          Type: String
          The name of the property to determine the enabled state for.
IsPropertyVisible(PropertyName As String) As Nullable(Of Boolean) Defines whether a property is currently visible.
Parameters
PropertyName
          Type: String
          The name of the property to determine the visible state for.
IsType(Type As Type) As Boolean Returns true if the object is of the type specified, or if it derives from the type specfied.
Parameters
Type
          Type: Type
          The type to check.
Serialize() As String Serializes the object.
SetDatabase(Database As GrooperDb) Sets the database connection of the object.
Parameters
Database
          Type: GrooperDb
          
SetOwner(Owner As ConnectedObject, SkipInitialization As Boolean) Sets the owner of the connected object with another object that implements the IConnected interface.
Parameters
Owner
          Type: ConnectedObject
          
 
SkipInitialization
          Type: Boolean
          
ToString() As String Returns a string value representation of the connected object.
TrainPages(dt As DocumentType, Pages As IEnumerable(Of IPage), Culture As CultureData, ipd As IProgressDisplay) As List(Of PageType) Trains this document type with the provided document sample. The provided sample is a list of pages which make up the document.
Parameters
dt
          Type: DocumentType
          
 
Pages
          Type: IEnumerable`1
          The document to be trained.
 
Culture
          Type: CultureData
          
 
ipd
          Type: IProgressDisplay
          
ValidateCache()
ValidateProperties() As ValidationErrorList Validates the properties of the object, returning a list of validation errors.