org.infinispan.api.annotations.indexing.option.Structure Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of infinispan-api Show documentation

Infinispan API

The newest version!

package org.infinispan.api.annotations.indexing.option;

/**
 * Defines how the structure of an object field is preserved upon indexing.
 * 
 * Simplified version for Infinispan of {@link org.hibernate.search.engine.backend.types.ObjectStructure}
 *
 * @since 14.0
 */
public enum Structure {

   /**
    * Flatten multi-valued object fields.
    * 

    * This structure is generally more efficient,
    * but has the disadvantage of dropping the original structure
    * by making the leaf fields multi-valued instead of the object fields.
    */
   FLATTENED,

   /**
    * Store object fields as nested documents.
    * 
    * This structure is generally less efficient,
    * but has the advantage of preserving the original structure.
    * Note however that access to that information when querying
    * requires special care.
    */
   NESTED

}