com.atlassian.confluence.plugins.contentproperty.index.schema

Class ContentPropertySchemaField

java.lang.Object

com.atlassian.confluence.plugins.contentproperty.index.schema.ContentPropertySchemaField

public class ContentPropertySchemaField
extends Object

Contains information how part of content property value (arbitrary JSON document) should be extracted into a cql field. BY default, eac extracted field can be access using a ContentPropertyFieldHandler. If an alias is defined for the field, then a FieldHandler for the alias is also registered.

Since:

5.7

Constructor Summary

Constructors

Constructor and Description
ContentPropertySchemaField(String jsonExpression, SchemaFieldType fieldType, String fieldName, String owningPlugin, String owningModule, String alias, com.atlassian.fugue.Option<com.atlassian.querylang.fields.UISupport> uiSupport)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAlias()
String	getFieldName()
SchemaFieldType	getFieldType()
String	getJsonExpression()
String	getOwningModule()
String	getOwningPlugin()
com.atlassian.fugue.Option<com.atlassian.querylang.fields.UISupport>	getUiSupport()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ContentPropertySchemaField

public ContentPropertySchemaField(String jsonExpression,
                                  SchemaFieldType fieldType,
                                  String fieldName,
                                  String owningPlugin,
                                  String owningModule,
                                  String alias,
                                  com.atlassian.fugue.Option<com.atlassian.querylang.fields.UISupport> uiSupport)

Parameters:

jsonExpression - Expression uses the dot notation to access the fields of an embedded document. To do so, concatenate the embedded document name with the dot (.) and the field name:
e.g. for JSON document

                                              {
                                                  "key-1" : {
                                                      "nested-1" : "apple",
                                                      "nested-2" : "pear"
                                                      },
                                                  "key-2" : [1, 2, 3]
                                              }
                                             

• "key-1.nested-1" expression would evaluate into a single String value "apple"
• "key-2" into an int array [1, 2, 3]
• "key-1" into a String array ["apple", "pear"]

fieldType - Supported index field type.

fieldName - Name of the field inside Lucene document.

Method Detail

getJsonExpression

public String getJsonExpression()

getFieldType

public SchemaFieldType getFieldType()

getFieldName

public String getFieldName()

getOwningPlugin

public String getOwningPlugin()

getOwningModule

public String getOwningModule()

getAlias

public String getAlias()

getUiSupport

public com.atlassian.fugue.Option<com.atlassian.querylang.fields.UISupport> getUiSupport()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object