Annotation Interface JsonView
@Retention(RUNTIME)
@Target({ANNOTATION_TYPE,TYPE,FIELD})
@Documented
@MappedEntity
@EntityRepresentation(type=COLUMN,
columnType=JSON)
public @interface JsonView
The annotation defining Json Duality View. Currently supported only by Oracle database.
@JsonView(value = "CONTACT_VIEW", alias = "cv", entity = Contact.class)
public class ContactView {
{@literal @Id}
{@literal @GeneratedValue(GeneratedValue.Type.IDENTITY)}
private Long id;
private String name;
private int age;
private LocalDateTime startDateTime;
private boolean active;
}
- Since:
- 4.0.0
- Author:
- radovanradic
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionThe name of the single column in the view.Class<?> The entity class.booleanWhether the columns of the table contribute to the ETAG of the document.String[]Properties of theentity()to expose as hidden fields.The supported sql operations array.Only applies to supported databases.The Json View name in the database.A SQL condition that restricts the rows of the root table exposed by the view, for example@.country = 'US'.
-
Field Details
-
DEFAULT_COLUMN_NAME
- See Also:
-
-
Element Details
-
entity
Class<?> entityThe entity class. Specify an entity class annotated withMappedEntitythat this JSON view corresponds to. Valid entity class is one that defines the properties used in this class.- Returns:
- the entity class, defaults to void
- Default:
void.class
-
operations
JsonView.Operation[] operationsThe supported sql operations array.- Returns:
- the supported operations array (default [UPDATE, INSERT, DELETE])
- Default:
{INSERT, UPDATE, DELETE}
-
column
The name of the single column in the view.- Returns:
- the column name (default DATA)
- Default:
"DATA"
-
value
The Json View name in the database.- Returns:
- the json view
- Default:
""
-
schema
Only applies to supported databases.- Returns:
- the schema to use for the query
- Default:
""
-
alias
- Returns:
- The view alias to use for the query
- Default:
""
-
where
String whereA SQL condition that restricts the rows of the root table exposed by the view, for example@.country = 'US'. Use the@.prefix to refer to columns of the table, it is replaced with the table alias. The view is generatedWITH CHECK OPTION, so inserting or updating a document that does not satisfy the condition fails.- Returns:
- the SQL condition
- Since:
- 5.3
- Default:
""
-
etagCheck
boolean etagCheckWhether the columns of the table contribute to the ETAG of the document. Whenfalsethe table is generated with theNOCHECKannotation.- Returns:
- true if the table is part of the ETAG check (default true)
- Since:
- 5.3
- Default:
true
-