FieldNames (platform/sdk 5.5.1.0-SNAPSHOT API)

java.lang.Object
- com.attivio.sdk.schema.FieldNames

```
public class FieldNames
extends Object
```
Contains document field names that are frequently used in the default Attivio transformers. Components can use different and/or non-defined field names however these are the defaults for all Attivio supplied transformers.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ANCESTOR_IDS` The field that will store the ID's of documents that are ancestors of a given document.
`static String`	`ANCHOR_TEXT` This field holds all of the anchor text for the links that point to this page/document.
`static String`	`CATEGORY` The field that holds the category of the document.
`static String`	`CHECKSUM` This field holds the SHA-256 checksum of this page/document.
`static String`	`CHILD_COUNT` This field holds the count of the number of children a particular document has.
`static String`	`CHILD_INDEX` This field holds the index of the child.
`static String`	`CHILD_PATH` Name of the field that will store the name or path of the child document by which it is referred to in the parent document.
`static String`	`CONCEPTS` The field that contains the concepts of the document.
`static String`	`CONNECTOR_TYPE` This field holds the name of the connector type.
`static String`	`CONTENT` The field containing all searchable content for the document.
`static String`	`CONTENT_POINTER` The field that holds the document content specified as a byte array.
`static String`	`CONTENT_POINTER_ID` The field that holds a content pointer id.
`static String`	`CONVERSION_ERROR` This field holds document conversion error strings.
`static String`	`CONVERSION_ERROR_CODE` This field holds document conversion error codes.
`static String`	`CONVERTED_FILE_PATH` This field holds document conversion error codes.
`static String`	`DATE` The field that holds the date.
`static String`	`DEFAULT_SEARCH_FIELD` The field that holds the "default search field".
`static String`	`DOC_STATUS` This field holds internal document status values.
`static String`	`DOCTYPE` The field that contains the document type.
`static String`	`DUPLICATES` This field holds a list of duplicate uris or doc ids of this page/document.
`static String`	`ENCODING` The field that contains the default document string encoding.
`static String`	`FIELD_NAMES` This field contains the name of all fields indexed for a document.
`static String`	`FILENAME` The field that contains the filename of the document.
`static String`	`FT_RETRY_COUNT` Field indicating the maximum number of times an `IngestDocument` will be retried for fault tolerance
`static String`	`HOSTNAME` The field that contains the hostname of a document.
`static String`	`ID` The internal field that holds the document id.
`static String`	`JOIN_CHILDREN_COUNT` Deprecated. This field is no longer used
`static String`	`JOIN_CLAUSE_NAME` This is the field that will return the name of the join clause (if annotated) for child documents.
`static String`	`JSON` Field for unparsed JSON text
`static String`	`LANGUAGE` The field that holds the document's primary language; string.
`static String`	`LANGUAGES` The field that holds the languages that are contained in the document in addition to primary language; string.
`static String`	`LATITUDE` Name of the field that will store latitude information for geo search.
`static String`	`LINEAGE_IDS` Name of the field that will store the ID's of containers (typically, folders) that are ancestors of a given document in a particular data source.
`static String`	`LINK_COUNT` This field holds the number of inbound links that point to this page/document.
`static String`	`LINK_FACTOR` This field holds the a scaled factor of the number of inbound links that point to this page/document.
`static String`	`LONGITUDE` Name of the field that will store longitude information for geo search.
`static String`	`MIME_TYPE` The field that contains the MIME type.
`static String`	`ORGANIZATIONS` The field that contains organizations mentioned in the document.
`static String`	`PARENT_DOCTYPE` The field that contains the parent document type.
`static String`	`PARENT_ID` The field that will store the document id of the parent document.
`static String`	`PARENT_MIME_TYPE` The field that holds the parent MIME type, if any.
`static String`	`PEOPLE` The field that contains people mentioned in the document.
`static String`	`POSITION` Name of the field that will store encoded position for geo search.
`static String`	`PROCESSING_FEEDBACK_COMPONENT` Field for component of processing feedback
`static String`	`PROCESSING_FEEDBACK_ERROR_CODE` Field for error code of processing feedback
`static String`	`PROCESSING_FEEDBACK_LEVEL` Field for level of processing feedback
`static String`	`PROCESSING_FEEDBACK_MESSAGE` Field for message of processing feedback
`static String`	`PROGENATOR_ID` The field that will store the document id of the parent document.
`static String`	`RANDOM_SORT` The virtual field used for sorting documents randomly
`static String`	`SCORE` The virtual field used for requesting/sorting by the score for a document.
`static String`	`SCORE_EXPLAIN` The field that will contain the explain map for scoring in a `SearchDocument`.
`static String`	`SENTIMENT` The field that contains the sentiment of the document.
`static String`	`SIZE` The field that will store a document's original size.
`static String`	`SOURCE_ENGINE` This field contains the engine name that the document came from.
`static String`	`SOURCEPATH` The field that contains the filepath of the document.
`static String`	`SOURCEURI` The field that holds the source URI of the document; string.
`static String`	`STATIC_FIELD_NAME` Field containing the list of static field names
`static String`	`TABLE` This field holds the commonly used table designation for a record for join based applications.
`static String`	`TEASER` This field holds a static teaser for a document's search result.
`static String`	`TEXT` The field where the primary raw text content for the document is placed.
`static String`	`TITLE` The field that holds the title of the document; string.
`static String`	`URI` The field that contains the URI of a document.
`static String`	`XML_DOM` The field for XML represented as DOM4J Document.
`static String`	`ZONE` The internal field used for populating/querying the zone for a document.

Constructor Summary

Constructors
Constructor and Description

FieldNames()

Constructors
Constructor and Description
`FieldNames()`

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

- Field Detail
  - ID
```
public static final String ID
```
    The internal field that holds the document id. Value: ".id"
    
    See Also:
    
    Constant Field Values
  - ZONE
```
public static final String ZONE
```
    The internal field used for populating/querying the zone for a document.
    
    See Also:
    
    Constant Field Values
  - SCORE
```
public static final String SCORE
```
    The virtual field used for requesting/sorting by the score for a document.
    
    See Also:
    
    Constant Field Values
  - RANDOM_SORT
```
public static final String RANDOM_SORT
```
    The virtual field used for sorting documents randomly
    
    See Also:
    
    Constant Field Values
  - FT_RETRY_COUNT
```
public static final String FT_RETRY_COUNT
```
    Field indicating the maximum number of times an IngestDocument will be retried for fault tolerance
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SEARCH_FIELD
```
public static final String DEFAULT_SEARCH_FIELD
```
    The field that holds the "default search field". Value: FieldNames.CONTENT
    
    See Also:
    
    Constant Field Values
  - TITLE
```
public static final String TITLE
```
    The field that holds the title of the document; string. Value: "title"
    
    See Also:
    
    Constant Field Values
  - LANGUAGE
```
public static final String LANGUAGE
```
    The field that holds the document's primary language; string. Value: "language"
    
    See Also:
    
    Constant Field Values
  - LANGUAGES
```
public static final String LANGUAGES
```
    The field that holds the languages that are contained in the document in addition to primary language; string. Value: "languages"
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final String DATE
```
    The field that holds the date. Value: "date"
    
    See Also:
    
    Constant Field Values
  - SOURCEURI
```
public static final String SOURCEURI
```
    The field that holds the source URI of the document; string. Value: "sourceuri"
    
    See Also:
    
    Constant Field Values
  - TEXT
```
public static final String TEXT
```
    The field where the primary raw text content for the document is placed. Value: "text"
    
    See Also:
    
    Constant Field Values
  - CONTENT
```
public static final String CONTENT
```
    The field containing all searchable content for the document. Value: "content"
    
    See Also:
    
    Constant Field Values
  - XML_DOM
```
public static final String XML_DOM
```
    The field for XML represented as DOM4J Document. Value: "xmldom"
    
    See Also:
    
    Constant Field Values
  - SOURCEPATH
```
public static final String SOURCEPATH
```
    The field that contains the filepath of the document. Default: "sourcepath"
    
    See Also:
    
    Constant Field Values
  - FILENAME
```
public static final String FILENAME
```
    The field that contains the filename of the document. Value: "filename"
    
    See Also:
    
    Constant Field Values
  - DOCTYPE
```
public static final String DOCTYPE
```
    The field that contains the document type. Value: "doctype"
    
    See Also:
    
    Constant Field Values
  - PARENT_DOCTYPE
```
public static final String PARENT_DOCTYPE
```
    The field that contains the parent document type. Value: "parentdoctype"
    
    See Also:
    
    Constant Field Values
  - CATEGORY
```
public static final String CATEGORY
```
    The field that holds the category of the document. Value: "cat"
    
    See Also:
    
    Constant Field Values
  - SENTIMENT
```
public static final String SENTIMENT
```
    The field that contains the sentiment of the document. Value: "sentiment"
    
    See Also:
    
    Constant Field Values
  - CONCEPTS
```
public static final String CONCEPTS
```
    The field that contains the concepts of the document. Value: "concepts"
    
    See Also:
    
    Constant Field Values
  - PEOPLE
```
public static final String PEOPLE
```
    The field that contains people mentioned in the document. Value: "people"
    
    See Also:
    
    Constant Field Values
  - ORGANIZATIONS
```
public static final String ORGANIZATIONS
```
    The field that contains organizations mentioned in the document. Value: "orgs"
    
    See Also:
    
    Constant Field Values
  - MIME_TYPE
```
public static final String MIME_TYPE
```
    The field that contains the MIME type. Value = "mimetype"
    
    See Also:
    
    Constant Field Values
  - PARENT_MIME_TYPE
```
public static final String PARENT_MIME_TYPE
```
    The field that holds the parent MIME type, if any. Value: "parentmimetype"
    
    See Also:
    
    Constant Field Values
  - CONTENT_POINTER
```
public static final String CONTENT_POINTER
```
    The field that holds the document content specified as a byte array. Value: "bytes"
    
    See Also:
    
    Constant Field Values
  - CONTENT_POINTER_ID
```
public static final String CONTENT_POINTER_ID
```
    The field that holds a content pointer id. Typically used by a transformer to convert into a content pointer
    
    See Also:
    
    Constant Field Values
  - URI
```
public static final String URI
```
    The field that contains the URI of a document. Value: "uri"
    
    See Also:
    
    Constant Field Values
  - HOSTNAME
```
public static final String HOSTNAME
```
    The field that contains the hostname of a document. Value: "hostname"
    
    See Also:
    
    Constant Field Values
  - ENCODING
```
public static final String ENCODING
```
    The field that contains the default document string encoding. Value: "encoding"
    
    See Also:
    
    Constant Field Values
  - SCORE_EXPLAIN
```
public static final String SCORE_EXPLAIN
```
    The field that will contain the explain map for scoring in a SearchDocument. Value: "score.explain"
    
    See Also:
    
    Constant Field Values
  - SIZE
```
public static final String SIZE
```
    The field that will store a document's original size. Value: "size"
    
    See Also:
    
    Constant Field Values
  - PARENT_ID
```
public static final String PARENT_ID
```
    The field that will store the document id of the parent document. Value: "parentid"
    
    See Also:
    
    Constant Field Values
  - PROGENATOR_ID
```
public static final String PROGENATOR_ID
```
    The field that will store the document id of the parent document. Value: "parentid"
    
    See Also:
    
    Constant Field Values
  - ANCESTOR_IDS
```
public static final String ANCESTOR_IDS
```
    The field that will store the ID's of documents that are ancestors of a given document. Value: "ancestorids"
    
    See Also:
    
    Constant Field Values
  - LINEAGE_IDS
```
public static final String LINEAGE_IDS
```
    Name of the field that will store the ID's of containers (typically, folders) that are ancestors of a given document in a particular data source. Also includes the ID of the document itself and is primarily used for document deletions. Value: "lineageids"
    
    See Also:
    
    Constant Field Values
  - POSITION
```
public static final String POSITION
```
    Name of the field that will store encoded position for geo search. Value: "position"
    
    See Also:
    
    Constant Field Values
  - LATITUDE
```
public static final String LATITUDE
```
    Name of the field that will store latitude information for geo search. Value: "latitude"
    
    See Also:
    
    Constant Field Values
  - LONGITUDE
```
public static final String LONGITUDE
```
    Name of the field that will store longitude information for geo search. Value: "longitude"
    
    See Also:
    
    Constant Field Values
  - CHILD_PATH
```
public static final String CHILD_PATH
```
    Name of the field that will store the name or path of the child document by which it is referred to in the parent document. For example, "dir1/dir2/doc1.txt" would be the value for a ZIP archive entry "dir1/dir2/doc1.txt". Value: "childpath"
    
    See Also:
    
    Constant Field Values
  - FIELD_NAMES
```
public static final String FIELD_NAMES
```
    This field contains the name of all fields indexed for a document. Value: ".fields"
    
    See Also:
    
    Constant Field Values
  - JOIN_CHILDREN_COUNT
```
@Deprecated
public static final String JOIN_CHILDREN_COUNT
```
    Deprecated. This field is no longer used
    
    See Also:
    
    Constant Field Values
  - JOIN_CLAUSE_NAME
```
public static final String JOIN_CLAUSE_NAME
```
    This is the field that will return the name of the join clause (if annotated) for child documents. Value: ".joinClauseName"
    
    See Also:
    
    Constant Field Values
  - SOURCE_ENGINE
```
public static final String SOURCE_ENGINE
```
    This field contains the engine name that the document came from. Primarily used in federation scenarios at response time to indicate where a document came from for front end presentation purposes. Value: "engine"
    
    See Also:
    
    Constant Field Values
  - CONNECTOR_TYPE
```
public static final String CONNECTOR_TYPE
```
    This field holds the name of the connector type. Useful to know what connector was used to bring a doc into index. Value: "connectortype"
    
    See Also:
    
    Constant Field Values
  - DOC_STATUS
```
public static final String DOC_STATUS
```
    This field holds internal document status values. Value: "docstatus"
    
    See Also:
    
    Constant Field Values
  - CONVERSION_ERROR
```
public static final String CONVERSION_ERROR
```
    This field holds document conversion error strings. Value: "conversionError"
    
    See Also:
    
    Constant Field Values
  - CONVERSION_ERROR_CODE
```
public static final String CONVERSION_ERROR_CODE
```
    This field holds document conversion error codes. Value: "conversionErrorCode"
    
    See Also:
    
    Constant Field Values
  - CONVERTED_FILE_PATH
```
public static final String CONVERTED_FILE_PATH
```
    This field holds document conversion error codes. Value: "convertedfilepath"
    
    See Also:
    
    Constant Field Values
  - CHILD_COUNT
```
public static final String CHILD_COUNT
```
    This field holds the count of the number of children a particular document has. Value: "childcount"
    
    See Also:
    
    Constant Field Values
  - CHILD_INDEX
```
public static final String CHILD_INDEX
```
    This field holds the index of the child. Value: "childindex"
    
    See Also:
    
    Constant Field Values
  - TABLE
```
public static final String TABLE
```
    This field holds the commonly used table designation for a record for join based applications. Value: "table"
    
    See Also:
    
    Constant Field Values
  - TEASER
```
public static final String TEASER
```
    This field holds a static teaser for a document's search result. Value: "teaser"
    
    See Also:
    
    Constant Field Values
  - ANCHOR_TEXT
```
public static final String ANCHOR_TEXT
```
    This field holds all of the anchor text for the links that point to this page/document. Value: "anchortext"
    
    See Also:
    
    Constant Field Values
  - LINK_COUNT
```
public static final String LINK_COUNT
```
    This field holds the number of inbound links that point to this page/document. Value: "linkcount"
    
    See Also:
    
    Constant Field Values
  - LINK_FACTOR
```
public static final String LINK_FACTOR
```
    This field holds the a scaled factor of the number of inbound links that point to this page/document. This field is primarily used for relevancy weighting purposes. Value: "linkfactor"
    
    See Also:
    
    Constant Field Values
  - DUPLICATES
```
public static final String DUPLICATES
```
    This field holds a list of duplicate uris or doc ids of this page/document. Value: "duplicates"
    
    See Also:
    
    Constant Field Values
  - CHECKSUM
```
public static final String CHECKSUM
```
    This field holds the SHA-256 checksum of this page/document. Value: "checksum"
    
    See Also:
    
    Constant Field Values
  - JSON
```
public static final String JSON
```
    Field for unparsed JSON text
    
    See Also:
    
    Constant Field Values
  - PROCESSING_FEEDBACK_LEVEL
```
public static final String PROCESSING_FEEDBACK_LEVEL
```
    Field for level of processing feedback
    
    See Also:
    
    Constant Field Values
  - PROCESSING_FEEDBACK_MESSAGE
```
public static final String PROCESSING_FEEDBACK_MESSAGE
```
    Field for message of processing feedback
    
    See Also:
    
    Constant Field Values
  - PROCESSING_FEEDBACK_COMPONENT
```
public static final String PROCESSING_FEEDBACK_COMPONENT
```
    Field for component of processing feedback
    
    See Also:
    
    Constant Field Values
  - PROCESSING_FEEDBACK_ERROR_CODE
```
public static final String PROCESSING_FEEDBACK_ERROR_CODE
```
    Field for error code of processing feedback
    
    See Also:
    
    Constant Field Values
  - STATIC_FIELD_NAME
```
public static final String STATIC_FIELD_NAME
```
    Field containing the list of static field names
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FieldNames
```
public FieldNames()
```

Class FieldNames

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ID

ZONE

SCORE

RANDOM_SORT

FT_RETRY_COUNT

DEFAULT_SEARCH_FIELD

TITLE

LANGUAGE

LANGUAGES

DATE

SOURCEURI

TEXT

CONTENT

XML_DOM

SOURCEPATH

FILENAME

DOCTYPE

PARENT_DOCTYPE

CATEGORY

SENTIMENT

CONCEPTS

PEOPLE

ORGANIZATIONS

MIME_TYPE

PARENT_MIME_TYPE

CONTENT_POINTER

CONTENT_POINTER_ID

URI

HOSTNAME

ENCODING

SCORE_EXPLAIN

SIZE

PARENT_ID

PROGENATOR_ID

ANCESTOR_IDS

LINEAGE_IDS

POSITION

LATITUDE

LONGITUDE

CHILD_PATH

FIELD_NAMES

JOIN_CHILDREN_COUNT

JOIN_CLAUSE_NAME

SOURCE_ENGINE

CONNECTOR_TYPE

DOC_STATUS

CONVERSION_ERROR

CONVERSION_ERROR_CODE

CONVERTED_FILE_PATH

CHILD_COUNT

CHILD_INDEX

TABLE

TEASER

ANCHOR_TEXT

LINK_COUNT

LINK_FACTOR

DUPLICATES

CHECKSUM

JSON

PROCESSING_FEEDBACK_LEVEL

PROCESSING_FEEDBACK_MESSAGE

PROCESSING_FEEDBACK_COMPONENT

PROCESSING_FEEDBACK_ERROR_CODE

STATIC_FIELD_NAME

Constructor Detail

FieldNames