ParserTokens.PROJECTIONARGS (Vitam API Reference (1.10.0-1))

java.lang.Object
- java.lang.Enum<ParserTokens.PROJECTIONARGS>
- - fr.gouv.vitam.common.database.parser.query.ParserTokens.PROJECTIONARGS

All Implemented Interfaces:

Serializable, Comparable<ParserTokens.PROJECTIONARGS>

Enclosing class:

ParserTokens
```
public static enum ParserTokens.PROJECTIONARGS
extends Enum<ParserTokens.PROJECTIONARGS>
```
specific fields: nbunits, dua, ...
$fields : [ #nbunits:1, #dua:1, #all:1... ]
#all:1 means all, while #all:0 means none

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALL` All fields for the result or None except Id
`ALLUNITUPS` All Unit's parents
`DUA` All Dua for the result
`ELIMINATION` elimination
`FORMAT` Object format
`GRAPH` Parent unit graph
`GRAPH_LAST_PERISTED_DATE` Graph last peristed date
`HISTORY` Parent unit history
`ID` Id of the item
`IMPLEMENTATIONVERSION` Vitam Implementation Version
`LAST_PERSISTED_DATE` Last persisted date (logbook operation & lifecycle documents)
`MANAGEMENT` Management bloc
`MAX` Unit's MAX distance from root
`MIN` Unit's MIN distance from root
`NBOBJECTS` Number of objects within ObjectGroup
`NBUNITS` Number of units immediate children from this Unit
`OBJECT` Unit's ObjectGroup
`OPERATIONS` Unit or GOT's list of participating operations
`OPI` Unit or GOT's initial operation
`ORIGINATING_AGENCIES` originating agencies
`ORIGINATING_AGENCY` originating agency
`PARENT_ORIGINATING_AGENCIES` Originating agency
`QUALIFIERS` Qualifiers field
`SCORE` Document scoring according to research
`SEDAVERSION` Seda Version
`SIZE` Object size
`STORAGE` Storage in OG
`TENANT` Unit/ObjectGroup Tenant
`TYPE` Unit/ObjectGroup type
`UDS` parents arrays
`UNITTYPE` unit type bloc
`UNITUPS` Unit's immediate parents
`USAGE` Document's usage (BINARY_MASTER, PHYSICAL_MASTER, DISSEMINATION, ...)
`VERSION` Document's version (number of update on document)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`exactToken()`
`static ParserTokens.PROJECTIONARGS`	`getPROJECTIONARGS(String name)` Translate intern field to external field.
`static boolean`	`isAnArray(String name)` Used in Set for Update
`static boolean`	`isNotAnalyzed(String name)` Return True if attribute is not analyzed
`static boolean`	`isValid(String token)` Used in projection for getObject
`static boolean`	`notAllowedOnSet(String name)` This function check the field name for know if it's allowed to inserting or updating the given field from external.
`static boolean`	`notAllowedOnSetExternal(String name)` This function check the field name for know if it's allowed to inserting or updating the given field from external.
`static ParserTokens.PROJECTIONARGS`	`parse(String name)` Parse the given name
`static ParserTokens.PROJECTIONARGS`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ParserTokens.PROJECTIONARGS[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ID
```
public static final ParserTokens.PROJECTIONARGS ID
```
    Id of the item
  - NBUNITS
```
public static final ParserTokens.PROJECTIONARGS NBUNITS
```
    Number of units immediate children from this Unit
  - NBOBJECTS
```
public static final ParserTokens.PROJECTIONARGS NBOBJECTS
```
    Number of objects within ObjectGroup
  - DUA
```
public static final ParserTokens.PROJECTIONARGS DUA
```
    All Dua for the result
  - ALL
```
public static final ParserTokens.PROJECTIONARGS ALL
```
    All fields for the result or None except Id
  - QUALIFIERS
```
public static final ParserTokens.PROJECTIONARGS QUALIFIERS
```
    Qualifiers field
  - SIZE
```
public static final ParserTokens.PROJECTIONARGS SIZE
```
    Object size
  - FORMAT
```
public static final ParserTokens.PROJECTIONARGS FORMAT
```
    Object format
  - TYPE
```
public static final ParserTokens.PROJECTIONARGS TYPE
```
    Unit/ObjectGroup type
  - TENANT
```
public static final ParserTokens.PROJECTIONARGS TENANT
```
    Unit/ObjectGroup Tenant
  - OBJECT
```
public static final ParserTokens.PROJECTIONARGS OBJECT
```
    Unit's ObjectGroup
  - UNITUPS
```
public static final ParserTokens.PROJECTIONARGS UNITUPS
```
    Unit's immediate parents
  - MIN
```
public static final ParserTokens.PROJECTIONARGS MIN
```
    Unit's MIN distance from root
  - MAX
```
public static final ParserTokens.PROJECTIONARGS MAX
```
    Unit's MAX distance from root
  - ALLUNITUPS
```
public static final ParserTokens.PROJECTIONARGS ALLUNITUPS
```
    All Unit's parents
  - MANAGEMENT
```
public static final ParserTokens.PROJECTIONARGS MANAGEMENT
```
    Management bloc
  - UNITTYPE
```
public static final ParserTokens.PROJECTIONARGS UNITTYPE
```
    unit type bloc
  - UDS
```
public static final ParserTokens.PROJECTIONARGS UDS
```
    parents arrays
  - OPERATIONS
```
public static final ParserTokens.PROJECTIONARGS OPERATIONS
```
    Unit or GOT's list of participating operations
  - OPI
```
public static final ParserTokens.PROJECTIONARGS OPI
```
    Unit or GOT's initial operation
  - ORIGINATING_AGENCY
```
public static final ParserTokens.PROJECTIONARGS ORIGINATING_AGENCY
```
    originating agency
  - ORIGINATING_AGENCIES
```
public static final ParserTokens.PROJECTIONARGS ORIGINATING_AGENCIES
```
    originating agencies
  - STORAGE
```
public static final ParserTokens.PROJECTIONARGS STORAGE
```
    Storage in OG
  - VERSION
```
public static final ParserTokens.PROJECTIONARGS VERSION
```
    Document's version (number of update on document)
  - USAGE
```
public static final ParserTokens.PROJECTIONARGS USAGE
```
    Document's usage (BINARY_MASTER, PHYSICAL_MASTER, DISSEMINATION, ...)
  - SCORE
```
public static final ParserTokens.PROJECTIONARGS SCORE
```
    Document scoring according to research
  - LAST_PERSISTED_DATE
```
public static final ParserTokens.PROJECTIONARGS LAST_PERSISTED_DATE
```
    Last persisted date (logbook operation & lifecycle documents)
  - GRAPH
```
public static final ParserTokens.PROJECTIONARGS GRAPH
```
    Parent unit graph
  - ELIMINATION
```
public static final ParserTokens.PROJECTIONARGS ELIMINATION
```
    elimination
  - GRAPH_LAST_PERISTED_DATE
```
public static final ParserTokens.PROJECTIONARGS GRAPH_LAST_PERISTED_DATE
```
    Graph last peristed date
  - PARENT_ORIGINATING_AGENCIES
```
public static final ParserTokens.PROJECTIONARGS PARENT_ORIGINATING_AGENCIES
```
    Originating agency
  - HISTORY
```
public static final ParserTokens.PROJECTIONARGS HISTORY
```
    Parent unit history
  - SEDAVERSION
```
public static final ParserTokens.PROJECTIONARGS SEDAVERSION
```
    Seda Version
  - IMPLEMENTATIONVERSION
```
public static final ParserTokens.PROJECTIONARGS IMPLEMENTATIONVERSION
```
    Vitam Implementation Version
- Method Detail
  - values
```
public static ParserTokens.PROJECTIONARGS[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ParserTokens.PROJECTIONARGS c : ParserTokens.PROJECTIONARGS.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ParserTokens.PROJECTIONARGS valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - exactToken
```
public final String exactToken()
```
    Returns:
    
    the exact token
  - isValid
```
public static final boolean isValid(String token)
```
    Used in projection for getObject
    
    Parameters:
    
    token - the token to valid
    
    Returns:
    
    True if this token is valid, even starting with a "_"
  - parse
```
public static final ParserTokens.PROJECTIONARGS parse(String name)
```
    Parse the given name
    
    Parameters:
    
    name - name of the field to parse
    
    Returns:
    
    the corresponding PROJECTIONARGS
    
    Throws:
    
    IllegalArgumentException - if not found
  - notAllowedOnSetExternal
```
public static boolean notAllowedOnSetExternal(String name)
```
    This function check the field name for know if it's allowed to inserting or updating the given field from external. This check is done by the API-internal by the VarNameAdapter.
    
    Parameters:
    
    name - field name
    
    Returns:
    
    True if the field is not allowed, false
  - getPROJECTIONARGS
```
public static ParserTokens.PROJECTIONARGS getPROJECTIONARGS(String name)
```
    Translate intern field to external field. This functionality is used by isNotAnalyzed() and isAnArray()
    
    Parameters:
    
    name - field name
    
    Returns:
    
    the PROJECTIONARGS associated
    
    Throws:
    
    IllegalArgumentException - if not found
  - isNotAnalyzed
```
public static boolean isNotAnalyzed(String name)
```
    Return True if attribute is not analyzed
    
    Parameters:
    
    name - field name
    
    Returns:
    
    True if attribute is not analyzed
  - isAnArray
```
public static boolean isAnArray(String name)
```
    Used in Set for Update
    
    Parameters:
    
    name - field name
    
    Returns:
    
    True if attribute is an array
  - notAllowedOnSet
```
public static boolean notAllowedOnSet(String name)
```
    This function check the field name for know if it's allowed to inserting or updating the given field from external. This check is done by the API-internal by the VarNameAdapter.
    
    Parameters:
    
    name - field name
    
    Returns:
    
    True if this value is not allowed on set (insert, update)

Enum ParserTokens.PROJECTIONARGS

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ID

NBUNITS

NBOBJECTS

DUA

ALL

QUALIFIERS

SIZE

FORMAT

TYPE

TENANT

OBJECT

UNITUPS

MIN

MAX

ALLUNITUPS

MANAGEMENT

UNITTYPE

UDS

OPERATIONS

OPI

ORIGINATING_AGENCY

ORIGINATING_AGENCIES

STORAGE

VERSION

USAGE

SCORE

LAST_PERSISTED_DATE

GRAPH

ELIMINATION

GRAPH_LAST_PERISTED_DATE

PARENT_ORIGINATING_AGENCIES

HISTORY

SEDAVERSION

IMPLEMENTATIONVERSION

Method Detail

values

valueOf

exactToken

isValid

parse

notAllowedOnSetExternal

getPROJECTIONARGS

isNotAnalyzed

isAnArray

notAllowedOnSet