Enum ParserTokens.PROJECTIONARGS
- java.lang.Object
-
- java.lang.Enum<ParserTokens.PROJECTIONARGS>
-
- fr.gouv.vitam.common.database.parser.query.ParserTokens.PROJECTIONARGS
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<ParserTokens.PROJECTIONARGS>
- Enclosing class:
- ParserTokens
public static enum ParserTokens.PROJECTIONARGS extends java.lang.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 Description ALL
All fields for the result or None except IdALLUNITUPS
All Unit's parentsATOMIC_VERSION
Document's version (number of update on document)COMPUTEDINHERITEDRULES
Vitam computedInheritedRules fieldDUA
All Dua for the resultELIMINATION
eliminationFORMAT
Object formatGRAPH
Parent unit graphGRAPH_LAST_PERISTED_DATE
Graph last peristed dateHISTORY
Parent unit historyID
Id of the itemIMPLEMENTATIONVERSION
Vitam Implementation VersionLAST_PERSISTED_DATE
Last persisted date (logbook operation & lifecycle documents)MANAGEMENT
Management blocMAX
Unit's MAX distance from rootMIN
Unit's MIN distance from rootNBOBJECTS
Number of objects within ObjectGroupNBUNITS
Number of units immediate children from this UnitOBJECT
Unit's ObjectGroupOPERATIONS
Unit or GOT's list of participating operationsOPI
Unit or GOT's initial operationOPTS
TRANSFERORIGINATING_AGENCIES
originating agenciesORIGINATING_AGENCY
originating agencyPARENT_ORIGINATING_AGENCIES
Originating agencyQUALIFIERS
Qualifiers fieldSCORE
Document scoring according to researchSEDAVERSION
Seda VersionSIZE
Object sizeSTORAGE
Storage in OGTENANT
Unit/ObjectGroup TenantTYPE
Unit/ObjectGroup typeUDS
parents arraysUNITTYPE
unit type blocUNITUPS
Unit's immediate parentsUSAGE
Document's usage (BINARY_MASTER, PHYSICAL_MASTER, DISSEMINATION, ...)VALIDCOMPUTEDINHERITEDRULES
VERSION
Document's version (number of update on document)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
exactToken()
static boolean
isValid(java.lang.String token)
Used in projection for getObjectstatic boolean
notAllowedOnSet(java.lang.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(java.lang.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(java.lang.String name)
Parse the given namestatic ParserTokens.PROJECTIONARGS
valueOf(java.lang.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.
-
-
-
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)
-
ATOMIC_VERSION
public static final ParserTokens.PROJECTIONARGS ATOMIC_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
-
COMPUTEDINHERITEDRULES
public static final ParserTokens.PROJECTIONARGS COMPUTEDINHERITEDRULES
Vitam computedInheritedRules field
-
VALIDCOMPUTEDINHERITEDRULES
public static final ParserTokens.PROJECTIONARGS VALIDCOMPUTEDINHERITEDRULES
-
OPTS
public static final ParserTokens.PROJECTIONARGS OPTS
TRANSFER
-
-
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(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
isValid
public static boolean isValid(java.lang.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 ParserTokens.PROJECTIONARGS parse(java.lang.String name)
Parse the given name- Parameters:
name
- name of the field to parse- Returns:
- the corresponding PROJECTIONARGS
- Throws:
java.lang.IllegalArgumentException
- if not found
-
notAllowedOnSetExternal
public static boolean notAllowedOnSetExternal(java.lang.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
-
notAllowedOnSet
public static boolean notAllowedOnSet(java.lang.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)
-
exactToken
public final java.lang.String exactToken()
- Returns:
- the exact token
-
-