TextAnalysisResult (fta 2.1.14 API)

java.lang.Object
- com.cobber.fta.TextAnalysisResult

```
public class TextAnalysisResult
extends java.lang.Object
```
TextAnalysisResult is the result of a TextAnalyzer analysis of a data stream.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`asJSON(boolean pretty, int verbose)` A JSON representation of the Analysis.
`long`	`getBlankCount()` Get the count of all blank samples.
`int`	`getCardinality()` Get the cardinality for the current data stream.
`java.util.Map<java.lang.String,java.lang.Long>`	`getCardinalityDetails()` Get the cardinality details for the current data stream.
`double`	`getConfidence()` Confidence in the type classification.
`DateTimeParser.DateResolutionMode`	`getDateResolutionMode()` Get the DateResolutionMode actually used to process Dates.
`char`	`getDecimalSeparator()` Get the Decimal Separator used to interpret Doubles.
`boolean`	`getLeadingWhiteSpace()` Does the set of elements contain any elements with leading White Space?
`long`	`getLeadingZeroCount()` Get the count of all samples with leading zeros (Type long only).
`long`	`getMatchCount()` Get the count of all (non-blank/non-null) samples that matched the determined type.
`int`	`getMaxLength()` Get the maximum length for Numeric, Boolean and String.
`java.lang.String`	`getMaxValue()` Get the maximum value for Numeric, Boolean and String.
`int`	`getMinLength()` Get the minimum length for Numeric, Boolean and String.
`java.lang.String`	`getMinValue()` Get the minimum value for Numeric, Boolean and String types.
`boolean`	`getMultiline()` Does the set of elements contain any multi-line elements?
`java.lang.String`	`getName()` Name of the data stream being analyzed.
`long`	`getNullCount()` Get the count of all null samples.
`int`	`getOutlierCount()` Get the number of distinct outliers for the current data stream.
`java.util.Map<java.lang.String,java.lang.Long>`	`getOutlierDetails()` Get the outlier details for the current data stream.
`java.lang.String`	`getRegExp()` Get Regular Expression that reflects the data stream.
`long`	`getSampleCount()` Get the count of all samples seen.
`java.lang.String`	`getSum()` Get the sum for Numeric types (Long, Double).
`boolean`	`getTrailingWhiteSpace()` Does the set of elements contain any elements with trailing White Space?
`PatternInfo.Type`	`getType()` Get 'Type' as determined by training to date.
`java.lang.String`	`getTypeQualifier()` Get the optional Type Qualifier.
`boolean`	`isKey()` Is this field a possible key?
`boolean`	`isLogicalType()` Is this a Logical Type?
`boolean`	`statisticsEnabled()` Was statistics collection enabled for this analysis.
`java.lang.String`	`toString()` A String representation of the Analysis.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getName
```
public java.lang.String getName()
```
    Name of the data stream being analyzed.
    
    Returns:
    
    Name of data stream..
  - getConfidence
```
public double getConfidence()
```
    Confidence in the type classification. Typically this will be the number of matches divided by the number of real samples. Where a real sample does not include either nulls or blanks.
    
    Returns:
    
    Confidence as a percentage.
  - getType
```
public PatternInfo.Type getType()
```
    Get 'Type' as determined by training to date.
    
    Returns:
    
    The Type of the data stream.
  - getTypeQualifier
```
public java.lang.String getTypeQualifier()
```
    Get the optional Type Qualifier. Predefined qualifiers are:
    - Type: BOOLEAN - "TRUE_FALSE", "YES_NO", "ONE_ZERO"
    - Type: STRING - "BLANK", "BLANKORNULL", "NULL"
    - Type: LONG - "GROUPING", "SIGNED". Note: "GROUPING" and "SIGNED" are independent and can both be present.
    - Type: DOUBLE - "GROUPING", "SIGNED". Note: "GROUPING" and "SIGNED" are independent and can both be present.
    - Type: DATE, TIME, DATETIME, ZONEDDATETIME, OFFSETDATETIME - The qualifier is the detailed date format string
    Note: Boolean TRUE_FALSE and YES_NO are not localized, i.e. these will only be detected if the field contains yes/no and true/false respectively. Note: Additional Type Qualifiers may be returned if any Logical Type plugins are installed. For example: If the Month Abbreviation plugin installed, the Base Type will be STRING, and the Qualifier will be "MONTHABBR".
    Returns:
    
    The Type Qualifier for the Type.
  - isLogicalType
```
public boolean isLogicalType()
```
    Is this a Logical Type?
    
    Returns:
    
    True if this is a Logical Type.
  - getMinValue
```
public java.lang.String getMinValue()
```
    Get the minimum value for Numeric, Boolean and String types.
    
    Returns:
    
    The minimum value as a String.
  - getMaxValue
```
public java.lang.String getMaxValue()
```
    Get the maximum value for Numeric, Boolean and String.
    
    Returns:
    
    The maximum value as a String.
  - getMinLength
```
public int getMinLength()
```
    Get the minimum length for Numeric, Boolean and String. Note: For String and Boolean types this length includes any whitespace.
    
    Returns:
    
    The minimum length.
  - getMaxLength
```
public int getMaxLength()
```
    Get the maximum length for Numeric, Boolean and String. Note: For String and Boolean types this length includes any whitespace.
    
    Returns:
    
    The maximum length.
  - getDecimalSeparator
```
public char getDecimalSeparator()
```
    Get the Decimal Separator used to interpret Doubles. Note: This will either be the Decimal Separator as per the locale or possibly a period.
    
    Returns:
    
    The Decimal Separator.
  - getDateResolutionMode
```
public DateTimeParser.DateResolutionMode getDateResolutionMode()
```
    Get the DateResolutionMode actually used to process Dates.
    
    Returns:
    
    The DateResolution mode used to process Dates.
  - getSum
```
public java.lang.String getSum()
```
    Get the sum for Numeric types (Long, Double).
    
    Returns:
    
    The sum.
  - getRegExp
```
public java.lang.String getRegExp()
```
    Get Regular Expression that reflects the data stream. All valid inputs should match this Regular Expression, however in some instances, not all inputs that match this RE are necessarily valid. For example, 28/13/2017 will match the RE (\d{2}/\d{2}/\d{4}) however this is not a valid date with pattern dd/MM/yyyy (there is no 13th month).
    
    Returns:
    
    The Regular Expression.
  - getMatchCount
```
public long getMatchCount()
```
    Get the count of all (non-blank/non-null) samples that matched the determined type. More formally the SampleCount is equal to the MatchCount + BlankCount + NullCount.
    
    Returns:
    
    Count of all matches.
  - getLeadingWhiteSpace
```
public boolean getLeadingWhiteSpace()
```
    Does the set of elements contain any elements with leading White Space?
    
    Returns:
    
    True if any elements matched have leading White Space.
  - getTrailingWhiteSpace
```
public boolean getTrailingWhiteSpace()
```
    Does the set of elements contain any elements with trailing White Space?
    
    Returns:
    
    True if any elements matched have trailing White Space.
  - getMultiline
```
public boolean getMultiline()
```
    Does the set of elements contain any multi-line elements?
    
    Returns:
    
    True if any elements matched are multi-line.
  - getSampleCount
```
public long getSampleCount()
```
    Get the count of all samples seen.
    
    Returns:
    
    Count of all samples.
  - getNullCount
```
public long getNullCount()
```
    Get the count of all null samples.
    
    Returns:
    
    Count of all null samples.
  - getBlankCount
```
public long getBlankCount()
```
    Get the count of all blank samples. Note: any number (including zero) of spaces are Blank.
    
    Returns:
    
    Count of all blank samples.
  - getLeadingZeroCount
```
public long getLeadingZeroCount()
```
    Get the count of all samples with leading zeros (Type long only). Note: a single '0' does not constitute a sample with a leading zero.
    
    Returns:
    
    Count of all leading zero samples.
  - getCardinality
```
public int getCardinality()
```
    Get the cardinality for the current data stream. See setMaxCardinality() method in TextAnalyzer. Note: The cardinality returned is the cardinality of the valid samples. For example, if a date is invalid it will not be included in the cardinality. Note: This is not a complete cardinality analysis unless the cardinality of the data stream is less than the maximum cardinality (Default: 12000). See also setMaxCardinality() method in TextAnalyzer.
    
    Returns:
    
    Count of all blank samples.
  - getCardinalityDetails
```
public java.util.Map<java.lang.String,java.lang.Long> getCardinalityDetails()
```
    Get the cardinality details for the current data stream. This is a Map of Strings and the count of occurrences.
    
    Returns:
    
    A Map of values and their occurrence frequency of the data stream to date.
  - getOutlierCount
```
public int getOutlierCount()
```
    Get the number of distinct outliers for the current data stream. See setMaxOutliers() method in TextAnalyzer. Note: This is not a complete outlier analysis unless the outlier count of the data stream is less than the maximum outlier count (Default: 50). See also setMaxOutliers() method in TextAnalyzer.
    
    Returns:
    
    Count of the distinct outliers.
  - getOutlierDetails
```
public java.util.Map<java.lang.String,java.lang.Long> getOutlierDetails()
```
    Get the outlier details for the current data stream. This is a Map of Strings and the count of occurrences.
    
    Returns:
    
    A Map of values and their occurrence frequency of the data stream to date.
  - isKey
```
public boolean isKey()
```
    Is this field a possible key?
    
    Returns:
    
    True if the field could be a key field.
  - statisticsEnabled
```
public boolean statisticsEnabled()
```
    Was statistics collection enabled for this analysis.
    
    Returns:
    
    True if statistics were collected.
  - toString
```
public java.lang.String toString()
```
    A String representation of the Analysis.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A String representation of the analysis to date.
  - asJSON
```
public java.lang.String asJSON(boolean pretty,
                               int verbose)
```
    A JSON representation of the Analysis.
    
    Parameters:
    
    pretty - If set, add minimal whitespace formatting.
    
    verbose - If set provides additional details on the core and Outlier sets.
    
    Returns:
    
    A JSON representation of the analysis.

Class TextAnalysisResult

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getName

getConfidence

getType

getTypeQualifier

isLogicalType

getMinValue

getMaxValue

getMinLength

getMaxLength

getDecimalSeparator

getDateResolutionMode

getSum

getRegExp

getMatchCount

getLeadingWhiteSpace

getTrailingWhiteSpace

getMultiline

getSampleCount

getNullCount

getBlankCount

getLeadingZeroCount

getCardinality

getCardinalityDetails

getOutlierCount

getOutlierDetails

isKey

statisticsEnabled

toString

asJSON