com.marklogic.client.pojo.annotation.GeospatialPathIndexProperty Maven / Gradle / Ivy

Go to download

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

The official MarkLogic Java client API.

The newest version!

/*
 * Copyright © 2024 MarkLogic Corporation. All Rights Reserved.
 */
package com.marklogic.client.pojo.annotation;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/** Use this annotation to specify that a Geospatial Path Index is needed
 * for this pojo property. The value should follow the rules
 * for any Geospatial Path Index in MarkLogic Server with coordinate
 * system "wgs84" and point format "point". Specifically, the value
 * should be in "{latititude} {longitude}" point format where {latitude}
 * and {longitude} are numeric geospatial wgs84 position values.
 *
 * This annotation can be associated with a public field:
 *     import com.marklogic.client.pojo.annotation.GeospatialPathIndexProperty;
 *    public class MyClass {
 *      {@literal @}GeospatialPathIndexProperty
 *      public String myGeoProperty;
 *    }
 *
 * or with a public getter method:
 *  *    public class MyClass {
 *      private String myGeoProperty;
 *      {@literal @}GeospatialPathIndexProperty
 *      public String getMyGeoProperty() {
 *        return myGeoProperty;
 *      }
 *      // ... setter methods ...
 *    }
 *
 * or with a public setter method:
 *  *    public class MyClass {
 *      private String myGeoProperty;
 *      // ... getter methods ...
 *      {@literal @}GeospatialPathIndexProperty
 *      public void setMyGeoProperty(String myGeoProperty) {
 *        this.myGeoProperty = myGeoProperty;
 *      }
 *    }
 * Run
 * {@link com.marklogic.client.pojo.util.GenerateIndexConfig} to generate
 * a package that can be used by administrators to create the indexes in
 * MarkLogic Server.
 */
@Retention(RetentionPolicy.RUNTIME)
public @interface GeospatialPathIndexProperty {
}