Package org.odpi.openmetadata.frameworks.openmetadata.properties.surveyreports

Class CodeAnalysisAnnotationProperties

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.EntityProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.AuthoredReferenceableProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.surveyreports.AnnotationProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.surveyreports.CodeAnalysisAnnotationProperties
public class CodeAnalysisAnnotationProperties extends AnnotationProperties
CodeAnalysisAnnotationProperties describes the content of the code in a code repository like GitHub.

  • Constructor Details

    • CodeAnalysisAnnotationProperties

      public CodeAnalysisAnnotationProperties()
      Default constructor

    • CodeAnalysisAnnotationProperties

      public CodeAnalysisAnnotationProperties(CodeAnalysisAnnotationProperties template)
      Copy clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getFileCount

      public long getFileCount()
      Return number of files in the source code repository.
      Returns:
      int

    • setFileCount

      public void setFileCount(long fileCount)
      Set up number of files in the source code repository.
      Parameters:
      fileCount - int

    • getLineCount

      public long getLineCount()
      Return total number of physical lines in the source code repository, including blank lines and comments.
      Returns:
      long

    • setLineCount

      public void setLineCount(long lineCount)
      Set up total number of physical lines in the source code repository, including blank lines and comments.
      Parameters:
      lineCount - long

    • getCodeLineCount

      public long getCodeLineCount()
      Return number of lines of code in the source code repository, excluding blank lines and comments.
      Returns:
      long

    • setCodeLineCount

      public void setCodeLineCount(long codeLineCount)
      Set up number of lines of code in the source code repository, excluding blank lines and comments.
      Parameters:
      codeLineCount - long

    • getCommentLineCount

      public long getCommentLineCount()
      Return number of comment lines in the source code repository.
      Returns:
      long

    • setCommentLineCount

      public void setCommentLineCount(long commentLineCount)
      Set up number of comment lines in the source code repository.
      Parameters:
      commentLineCount - long

    • getPrimaryLanguage

      public String getPrimaryLanguage()
      Return the programming language that most of the source code in the repository is written in.
      Returns:
      string

    • setPrimaryLanguage

      public void setPrimaryLanguage(String primaryLanguage)
      Set up the programming language that most of the source code in the repository is written in.
      Parameters:
      primaryLanguage - string

    • getLanguageCount

      public long getLanguageCount()
      Return number of distinct programming languages used in the source code repository.
      Returns:
      int

    • setLanguageCount

      public void setLanguageCount(long languageCount)
      Set up number of distinct programming languages used in the source code repository.
      Parameters:
      languageCount - int

    • getPublicSymbolCount

      public long getPublicSymbolCount()
      Return number of symbols that the component exports for use by its callers, such as public functions, classes and endpoints.
      Returns:
      long

    • setPublicSymbolCount

      public void setPublicSymbolCount(long publicSymbolCount)
      Set up number of symbols that the component exports for use by its callers, such as public functions, classes and endpoints.
      Parameters:
      publicSymbolCount - long

    • getEntryPointCount

      public long getEntryPointCount()
      Return number of entry points into the component, such as main methods, command line commands, route handlers and task definitions.
      Returns:
      int

    • setEntryPointCount

      public void setEntryPointCount(long entryPointCount)
      Set up number of entry points into the component, such as main methods, command line commands, route handlers and task definitions.
      Parameters:
      entryPointCount - int

    • getDataReadCount

      public long getDataReadCount()
      Return number of places in the code where data is read.
      Returns:
      long

    • setDataReadCount

      public void setDataReadCount(long dataReadCount)
      Set up number of places in the code where data is read.
      Parameters:
      dataReadCount - long

    • getDataCreateCount

      public long getDataCreateCount()
      Return number of places in the code where data is created.
      Returns:
      long

    • setDataCreateCount

      public void setDataCreateCount(long dataCreateCount)
      Set up number of places in the code where data is created.
      Parameters:
      dataCreateCount - long

    • getDataUpdateCount

      public long getDataUpdateCount()
      Return number of places in the code where data is updated.
      Returns:
      long

    • setDataUpdateCount

      public void setDataUpdateCount(long dataUpdateCount)
      Set up number of places in the code where data is updated.
      Parameters:
      dataUpdateCount - long

    • getDataDeleteCount

      public long getDataDeleteCount()
      Return number of places in the code where data is deleted.
      Returns:
      long

    • setDataDeleteCount

      public void setDataDeleteCount(long dataDeleteCount)
      Set up number of places in the code where data is deleted.
      Parameters:
      dataDeleteCount - long

    • getDataChecksCount

      public long getDataChecksCount()
      Return number of places in the code where data is validated.
      Returns:
      long

    • setDataChecksCount

      public void setDataChecksCount(long dataChecksCount)
      Set up number of places in the code where data is validated.
      Parameters:
      dataChecksCount - long

    • getDataStoreCount

      public long getDataStoreCount()
      Return number of distinct data stores that the code touches.
      Returns:
      long

    • setDataStoreCount

      public void setDataStoreCount(long dataStoreCount)
      Set up number of distinct data stores that the code touches.
      Parameters:
      dataStoreCount - long

    • getExternalCallCount

      public long getExternalCallCount()
      Return number of calls that the code makes out of the component.
      Returns:
      long

    • setExternalCallCount

      public void setExternalCallCount(long externalCallCount)
      Set up number of calls that the code makes out of the component.
      Parameters:
      externalCallCount - long

    • getFunctionCount

      public long getFunctionCount()
      Return number of functions in the source code repository.
      Returns:
      long

    • setFunctionCount

      public void setFunctionCount(long functionCount)
      Set up number of functions in the source code repository.
      Parameters:
      functionCount - long

    • getCyclomaticComplexityTotal

      public long getCyclomaticComplexityTotal()
      Return sum of the cyclomatic complexity of every function in the source code repository.
      Returns:
      long

    • setCyclomaticComplexityTotal

      public void setCyclomaticComplexityTotal(long cyclomaticComplexityTotal)
      Set up sum of the cyclomatic complexity of every function in the source code repository.
      Parameters:
      cyclomaticComplexityTotal - long

    • getCyclomaticComplexityMax

      public long getCyclomaticComplexityMax()
      Return the highest cyclomatic complexity found in any single function in the source code repository.
      Returns:
      int

    • setCyclomaticComplexityMax

      public void setCyclomaticComplexityMax(long cyclomaticComplexityMax)
      Set up the highest cyclomatic complexity found in any single function in the source code repository.
      Parameters:
      cyclomaticComplexityMax - int

    • getMaxNestingDepth

      public long getMaxNestingDepth()
      Return the deepest level of nested control flow found in any single function in the source code repository.
      Returns:
      int

    • setMaxNestingDepth

      public void setMaxNestingDepth(long maxNestingDepth)
      Set up the deepest level of nested control flow found in any single function in the source code repository.
      Parameters:
      maxNestingDepth - int

    • getTestFileCount

      public long getTestFileCount()
      Return number of files in the source code repository that contain tests.
      Returns:
      int

    • setTestFileCount

      public void setTestFileCount(long testFileCount)
      Set up number of files in the source code repository that contain tests.
      Parameters:
      testFileCount - int

    • getDocumentedSymbolCount

      public long getDocumentedSymbolCount()
      Return number of exported symbols that carry documentation.
      Returns:
      long

    • setDocumentedSymbolCount

      public void setDocumentedSymbolCount(long documentedSymbolCount)
      Set up number of exported symbols that carry documentation.
      Parameters:
      documentedSymbolCount - long

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class AnnotationProperties
      Returns:
      print out of variables in a JSON-style

    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class AnnotationProperties
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Create a hash code for this element type.
      Overrides:
      hashCode in class AnnotationProperties
      Returns:
      int hash code