ArcGIS Pro 3.2 API Reference Guide
ArcGIS.Core.Data.Knowledge Namespace / KnowledgeGraphEntityType Class
Members Example

In This Topic
    KnowledgeGraphEntityType Class
    In This Topic
    Represents an entity type in the knowledge graph.
    Syntax
    public sealed class KnowledgeGraphEntityType : KnowledgeGraphNamedObjectType, System.IDisposable  
    Public NotInheritable Class KnowledgeGraphEntityType 
       Inherits KnowledgeGraphNamedObjectType
       Implements System.IDisposable 
    Example
    Get Data Model MetaEntityTypes/Provenance
    //Provenance entity type is stored as a MetaEntityType 
    QueuedTask.Run(() =>
    {
      //Create a connection properties
      var kg_props =
          new KnowledgeGraphConnectionProperties(new Uri(url));
      using (var kg = new KnowledgeGraph(kg_props))
      {
        //Get the KnowledgeGraph Data Model
        using (var kg_dm = kg.GetDataModel())
        {
          var dict_types = kg_dm.GetMetaEntityTypes();
          //If there is no provenance then MetaEntityTypes will be
          //an empty collection
          foreach (var kvp in dict_types)
          {
            var meta_entity_type = kvp.Value;
            if (meta_entity_type.GetRole() == 
                KnowledgeGraphNamedObjectTypeRole.Provenance)
            {
              //TODO - use the provenance entity type
              var name = meta_entity_type.GetName();
    
            }
          }
          
        }
      }
    });
    
    Get Whether KG Supports Provenance
    internal string GetProvenanceEntityTypeName(KnowledgeGraphDataModel kg_dm)
    {
      var entity_types = kg_dm.GetMetaEntityTypes();
      foreach (var entity_type in entity_types)
      {
        if (entity_type.Value.GetRole() == KnowledgeGraphNamedObjectTypeRole.Provenance)
          return entity_type.Value.GetName();
      }
      return "";
    }
    internal bool KnowledgeGraphSupportsProvenance(KnowledgeGraph kg)
    {
      //if there is a provenance entity type then the KnowledgeGraph
      //supports provenance
      return !string.IsNullOrEmpty(
        GetProvenanceEntityTypeName(kg.GetDataModel()));
    }
    Get KnowledgeGraph Entity Types
    QueuedTask.Run(() =>
    {
      //Create a connection properties
      var kg_props =
          new KnowledgeGraphConnectionProperties(new Uri(url));
      using (var kg = new KnowledgeGraph(kg_props))
      {
        //Get the KnowledgeGraph Data Model
        using (var kg_dm = kg.GetDataModel())
        {
          var dict_types = kg_dm.GetEntityTypes();
    
          foreach (var kvp in dict_types)
          {
            var entity_type = kvp.Value;
            var role = entity_type.GetRole();
            //note "name" will be the same name as the corresponding
            //feature class or table in the KG's relational gdb model
            var name = entity_type.GetName();
            //etc
    
          }
    
        }
      }
    });
    
    Get Whether KG Has a Document Type
    internal string GetDocumentEntityTypeName(KnowledgeGraphDataModel kg_dm)
    {
      var entity_types = kg_dm.GetEntityTypes();
      foreach (var entity_type in entity_types)
      {
        var role = entity_type.Value.GetRole();
        if (role == KnowledgeGraphNamedObjectTypeRole.Document)
          return entity_type.Value.GetName();
      }
      return "";//Unusual - probably Neo4j user-managed
    }
    
    internal bool KnowledgeGraphHasDocumentType(KnowledgeGraph kg)
    {
      //uncommon for there not to be a document type
      return !string.IsNullOrEmpty(
        GetDocumentEntityTypeName(kg.GetDataModel()));
    }
    Check Whether A KG Entity Is a Document
    //Use GetDocumentEntityTypeName(KnowledgeGraphDataModel kg_dm) from
    //the 'Get Whether KG Has a Document Type' snippet to
    //get the documentNameType parameter
    protected bool GetEntityIsDocument(KnowledgeGraphEntityValue entity,
      string documentNameType = "")
    {
      if (string.IsNullOrEmpty(documentNameType))
        return false;
      return entity.GetTypeName() == documentNameType;
    }
    
    Inheritance Hierarchy

    System.Object
       ArcGIS.Core.CoreObjectsBase
          ArcGIS.Core.Data.Knowledge.KnowledgeGraphNamedObjectType
             ArcGIS.Core.Data.Knowledge.KnowledgeGraphEntityType

    Requirements

    Target Platforms: Windows 11, Windows 10

    ArcGIS Pro version: 3.2 or higher.
    See Also