Package com.aerospike.mapper.tools

Class AeroMapper

java.lang.Object
com.aerospike.mapper.tools.AeroMapper
All Implemented Interfaces:
IAeroMapper, IBaseAeroMapper
public class AeroMapper
extends Object
implements IAeroMapper

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  AeroMapper.Builder  

  • Method Summary

    Modifier and Type Method Description
    <T> VirtualList<T> asBackedList​(@NotNull Class<?> owningClazz, @NotNull Object key, @NotNull String binName, Class<T> elementClazz)
    Create a virtual list against an attribute on a class.
    <T> VirtualList<T> asBackedList​(@NotNull Object object, @NotNull String binName, Class<T> elementClazz)
    Create a virtual list against an attribute on a class.
    IAeroMapper asMapper()  
    <T> boolean delete​(@NotNull Class<T> clazz, @NotNull Object userKey)
    Delete a record by specifying a class and a user key.
    boolean delete​(@NotNull Object object)
    Delete a record by specifying an object.
    <T> boolean delete​(com.aerospike.client.policy.WritePolicy writePolicy, @NotNull Class<T> clazz, @NotNull Object userKey)
    Delete a record by specifying a write policy, a class and a user key.
    boolean delete​(com.aerospike.client.policy.WritePolicy writePolicy, @NotNull Object object)
    Delete a record by specifying a write policy and an object.
    <T> void find​(@NotNull Class<T> clazz, Function<T,​Boolean> function)
    Find a record by specifying a class and a Boolean function.
    com.aerospike.client.policy.BatchPolicy getBatchPolicy​(Class<?> clazz)
    Return the batch policy to be used for the passed class.
    com.aerospike.client.IAerospikeClient getClient()  
    MappingConverter getMappingConverter()  
    com.aerospike.client.policy.QueryPolicy getQueryPolicy​(Class<?> clazz)
    Return the query policy to be used for the passed class.
    com.aerospike.client.policy.Policy getReadPolicy​(Class<?> clazz)
    Return the read policy to be used for the passed class.
    com.aerospike.client.policy.ScanPolicy getScanPolicy​(Class<?> clazz)
    Return the scan policy to be used for the passed class.
    com.aerospike.client.policy.WritePolicy getWritePolicy​(Class<?> clazz)
    Return the write policy to be used for the passed class.
    <T> T read​(@NotNull Class<T> clazz, @NotNull Object userKey)
    Read a record from the repository and map it to an instance of the passed class.
    <T> T[] read​(@NotNull Class<T> clazz, @NotNull Object... userKeys)
    Read a batch of records from the repository and map them to an instance of the passed class.
    <T> T read​(@NotNull Class<T> clazz, @NotNull Object userKey, boolean resolveDependencies)
    This method should not be used: It is used by mappers to correctly resolved dependencies.
    <T> T[] read​(com.aerospike.client.policy.BatchPolicy batchPolicy, @NotNull Class<T> clazz, @NotNull Object... userKeys)
    Read a batch of records from the repository and map them to an instance of the passed class.
    <T> T read​(com.aerospike.client.policy.Policy readPolicy, @NotNull Class<T> clazz, @NotNull Object userKey)
    Read a record from the repository and map it to an instance of the passed class.
    <T> T read​(com.aerospike.client.policy.Policy readPolicy, @NotNull Class<T> clazz, @NotNull Object userKey, boolean resolveDependencies)
    This method should not be used except by mappers
    <T> T readFromDigest​(@NotNull Class<T> clazz, @javax.validation.constraints.NotNull byte[] digest)
    Read a record from the repository and map it to an instance of the passed class, by providing a digest.
    <T> T readFromDigest​(@NotNull Class<T> clazz, @javax.validation.constraints.NotNull byte[] digest, boolean resolveDependencies)
    This method should not be used except by mappers
    <T> T readFromDigest​(com.aerospike.client.policy.Policy readPolicy, @NotNull Class<T> clazz, @javax.validation.constraints.NotNull byte[] digest)
    Read a record from the repository and map it to an instance of the passed class, by providing a digest.
    <T> T readFromDigest​(com.aerospike.client.policy.Policy readPolicy, @NotNull Class<T> clazz, @javax.validation.constraints.NotNull byte[] digest, boolean resolveDependencies)
    This method should not be used except by mappers
    void save​(@NotNull com.aerospike.client.policy.WritePolicy writePolicy, @NotNull Object object, String... binNames)
    Save an object in the database with the given WritePolicy.
    void save​(@NotNull Object... objects)
    Save each object in the database.
    void save​(@NotNull Object object, String... binNames)
    Save an object in the database.
    void update​(@NotNull Object object, String... binNames)
    Updates the object in the database, merging the record with the existing record.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • save

      public void save​(@NotNull @NotNull Object... objects) throws com.aerospike.client.AerospikeException
      Save each object in the database. This method will perform a REPLACE on the existing record so any existing data will be overwritten by the data in the passed object. This is a convenience method for 
       save(A);
 save(B);
 save(C);
      Not that no transactionality is implied by this method -- if any of the save methods fail, the exception will be thrown without trying the other objects, nor attempting to roll back previously saved objects
      Specified by:
      save in interface IAeroMapper
      Parameters:
      objects - One or two objects to save.
      Throws:
      com.aerospike.client.AerospikeException - an AerospikeException will be thrown in case of an error.

    • save

      public void save​(@NotNull @NotNull Object object, String... binNames) throws com.aerospike.client.AerospikeException
      Save an object in the database. This method will perform a REPLACE on the existing record so any existing data will be overwritten by the data in the passed object
      Specified by:
      save in interface IAeroMapper
      Parameters:
      object - The object to save.
      Throws:
      com.aerospike.client.AerospikeException - an AerospikeException will be thrown in case of an error.

    • save

      public void save​(@NotNull @NotNull com.aerospike.client.policy.WritePolicy writePolicy, @NotNull @NotNull Object object, String... binNames) throws com.aerospike.client.AerospikeException
      Save an object in the database with the given WritePolicy. This write policy will override any other set writePolicy so is effectively an upsert operation
      Specified by:
      save in interface IAeroMapper
      Parameters:
      writePolicy - The write policy for the save operation.
      object - The object to save.
      Throws:
      com.aerospike.client.AerospikeException - an AerospikeException will be thrown in case of an error.

    • update

      public void update​(@NotNull @NotNull Object object, String... binNames) throws com.aerospike.client.AerospikeException
      Updates the object in the database, merging the record with the existing record. This uses the RecordExistsAction of UPDATE. If bins are specified, only bins with the passed names will be updated (or all of them if null is passed)
      Specified by:
      update in interface IAeroMapper
      Parameters:
      object - The object to update.
      Throws:
      com.aerospike.client.AerospikeException - an AerospikeException will be thrown in case of an error.

    • readFromDigest

      public <T> T readFromDigest​(@NotNull @NotNull Class<T> clazz, @NotNull @javax.validation.constraints.NotNull byte[] digest) throws com.aerospike.client.AerospikeException
      Read a record from the repository and map it to an instance of the passed class, by providing a digest.
      Specified by:
      readFromDigest in interface IAeroMapper
      Parameters:
      clazz - - The type of the record.
      digest - - The Aerospike digest (Unique server hash value generated from set name and user key).
      Returns:
      The returned mapped record.
      Throws:
      com.aerospike.client.AerospikeException - an AerospikeException will be thrown in case of an error.

    • readFromDigest

      public <T> T readFromDigest​(@NotNull @NotNull Class<T> clazz, @NotNull @javax.validation.constraints.NotNull byte[] digest, boolean resolveDependencies) throws com.aerospike.client.AerospikeException
      This method should not be used except by mappers
      Specified by:
      readFromDigest in interface IAeroMapper
      Throws:
      com.aerospike.client.AerospikeException

    • readFromDigest

      public <T> T readFromDigest​(com.aerospike.client.policy.Policy readPolicy, @NotNull @NotNull Class<T> clazz, @NotNull @javax.validation.constraints.NotNull byte[] digest) throws com.aerospike.client.AerospikeException
      Read a record from the repository and map it to an instance of the passed class, by providing a digest.
      Specified by:
      readFromDigest in interface IAeroMapper
      Parameters:
      readPolicy - - The read policy for the read operation.
      clazz - - The type of the record.
      digest - - The Aerospike digest (Unique server hash value generated from set name and user key).
      Returns:
      The returned mapped record.
      Throws:
      com.aerospike.client.AerospikeException - an AerospikeException will be thrown in case of an error.

    • readFromDigest

      public <T> T readFromDigest​(com.aerospike.client.policy.Policy readPolicy, @NotNull @NotNull Class<T> clazz, @NotNull @javax.validation.constraints.NotNull byte[] digest, boolean resolveDependencies) throws com.aerospike.client.AerospikeException
      This method should not be used except by mappers
      Specified by:
      readFromDigest in interface IAeroMapper
      Throws:
      com.aerospike.client.AerospikeException

    • read

      public <T> T read​(@NotNull @NotNull Class<T> clazz, @NotNull @NotNull Object userKey) throws com.aerospike.client.AerospikeException
      Read a record from the repository and map it to an instance of the passed class.
      Specified by:
      read in interface IAeroMapper
      Parameters:
      clazz - - The type of be returned.
      userKey - - The key of the record. The namespace and set will be derived from the values specified on the passed class.
      Returns:
      The returned mapped record.
      Throws:
      com.aerospike.client.AerospikeException - an AerospikeException will be thrown in case of an error.

    • read

      public <T> T read​(@NotNull @NotNull Class<T> clazz, @NotNull @NotNull Object userKey, boolean resolveDependencies) throws com.aerospike.client.AerospikeException
      This method should not be used: It is used by mappers to correctly resolved dependencies. Use read(clazz, userKey) instead
      Specified by:
      read in interface IAeroMapper
      Throws:
      com.aerospike.client.AerospikeException

    • read

      public <T> T read​(com.aerospike.client.policy.Policy readPolicy, @NotNull @NotNull Class<T> clazz, @NotNull @NotNull Object userKey) throws com.aerospike.client.AerospikeException
      Read a record from the repository and map it to an instance of the passed class.
      Specified by:
      read in interface IAeroMapper
      Parameters:
      readPolicy - - The read policy for the read operation.
      clazz - - The type of be returned.
      userKey - - The key of the record. The namespace and set will be derived from the values specified on the passed class.
      Returns:
      The returned mapped record.
      Throws:
      com.aerospike.client.AerospikeException - an AerospikeException will be thrown in case of an error.

    • read

      public <T> T read​(com.aerospike.client.policy.Policy readPolicy, @NotNull @NotNull Class<T> clazz, @NotNull @NotNull Object userKey, boolean resolveDependencies) throws com.aerospike.client.AerospikeException
      This method should not be used except by mappers
      Specified by:
      read in interface IAeroMapper
      Throws:
      com.aerospike.client.AerospikeException

    • read

      public <T> T[] read​(@NotNull @NotNull Class<T> clazz, @NotNull @NotNull Object... userKeys) throws com.aerospike.client.AerospikeException
      Read a batch of records from the repository and map them to an instance of the passed class.
      Specified by:
      read in interface IAeroMapper
      Parameters:
      clazz - - The type of be returned.
      userKeys - - The keys of the record. The namespace and set will be derived from the values specified on the passed class.
      Returns:
      The returned mapped records.
      Throws:
      com.aerospike.client.AerospikeException - an AerospikeException will be thrown in case of an error.

    • read

      public <T> T[] read​(com.aerospike.client.policy.BatchPolicy batchPolicy, @NotNull @NotNull Class<T> clazz, @NotNull @NotNull Object... userKeys) throws com.aerospike.client.AerospikeException
      Read a batch of records from the repository and map them to an instance of the passed class.
      Specified by:
      read in interface IAeroMapper
      Parameters:
      batchPolicy - A given batch policy.
      clazz - - The type of be returned.
      userKeys - - The keys of the record. The namespace and set will be derived from the values specified on the passed class.
      Returns:
      The returned mapped records.
      Throws:
      com.aerospike.client.AerospikeException - an AerospikeException will be thrown in case of an error.

    • delete

      public <T> boolean delete​(@NotNull @NotNull Class<T> clazz, @NotNull @NotNull Object userKey) throws com.aerospike.client.AerospikeException
      Delete a record by specifying a class and a user key.
      Specified by:
      delete in interface IAeroMapper
      Parameters:
      clazz - - The type of the record.
      userKey - - The key of the record. The namespace and set will be derived from the values specified on the passed class.
      Returns:
      whether record existed on server before deletion
      Throws:
      com.aerospike.client.AerospikeException - an AerospikeException will be thrown in case of an error.

    • delete

      public <T> boolean delete​(com.aerospike.client.policy.WritePolicy writePolicy, @NotNull @NotNull Class<T> clazz, @NotNull @NotNull Object userKey) throws com.aerospike.client.AerospikeException
      Delete a record by specifying a write policy, a class and a user key.
      Specified by:
      delete in interface IAeroMapper
      Parameters:
      writePolicy - - The write policy for the delete operation.
      clazz - - The type of the record.
      userKey - - The key of the record. The namespace and set will be derived from the values specified on the passed class.
      Returns:
      whether record existed on server before deletion
      Throws:
      com.aerospike.client.AerospikeException - an AerospikeException will be thrown in case of an error.

    • delete

      public boolean delete​(@NotNull @NotNull Object object) throws com.aerospike.client.AerospikeException
      Delete a record by specifying an object.
      Specified by:
      delete in interface IAeroMapper
      Parameters:
      object - The object to delete.
      Returns:
      whether record existed on server before deletion
      Throws:
      com.aerospike.client.AerospikeException - an AerospikeException will be thrown in case of an error.

    • delete

      public boolean delete​(com.aerospike.client.policy.WritePolicy writePolicy, @NotNull @NotNull Object object) throws com.aerospike.client.AerospikeException
      Delete a record by specifying a write policy and an object.
      Specified by:
      delete in interface IAeroMapper
      Parameters:
      writePolicy - - The write policy for the delete operation.
      object - The object to delete.
      Returns:
      whether record existed on server before deletion
      Throws:
      com.aerospike.client.AerospikeException - an AerospikeException will be thrown in case of an error.

    • asBackedList

      public <T> VirtualList<T> asBackedList​(@NotNull @NotNull Object object, @NotNull @NotNull String binName, Class<T> elementClazz)
      Create a virtual list against an attribute on a class. The list does all operations to the database and does not affect the underlying class, and is useful for situation when operations are needed to affect the database without having to return all the elements on the list each time.

      For example, consider a set of transactions associated with a credit card. Common operations might be

      • Return the last N transactions
      • insert a new transaction into the list
      These operation can all be done without having the full set of transactions
      Specified by:
      asBackedList in interface IAeroMapper
      Type Parameters:
      T - the type of the elements in the list.
      Parameters:
      object - The object that will use as a base for the virtual list.
      binName - The Aerospike bin name.
      elementClazz - The class of the elements in the list.
      Returns:
      A virtual list.

    • asBackedList

      public <T> VirtualList<T> asBackedList​(@NotNull @NotNull Class<?> owningClazz, @NotNull @NotNull Object key, @NotNull @NotNull String binName, Class<T> elementClazz)
      Create a virtual list against an attribute on a class. The list does all operations to the database and does not affect the underlying class, and is useful for situation when operations are needed to affect the database without having to return all the elements on the list each time.

      Note that the object being mapped does not need to actually exist in this case. The owning class is used purely for the definitions of how to map the list elements (are they to be mapped in the database as a list or a map, is each element a list or a map, etc), as well as using the namespace / set definition for the location to map into the database. The passed key is used to map the object to the database.

      For example, consider a set of transactions associated with a credit card. Common operations might be

      • Return the last N transactions
      • insert a new transaction into the list
      These operation can all be done without having the full set of transactions
      Specified by:
      asBackedList in interface IAeroMapper
      Type Parameters:
      T - the type of the elements in the list.
      Parameters:
      owningClazz - Used for the definitions of how to map the list elements.
      key - The key to map the object to the database.
      binName - The Aerospike bin name.
      elementClazz - The class of the elements in the list.
      Returns:
      A virtual list.

    • find

      public <T> void find​(@NotNull @NotNull Class<T> clazz, Function<T,​Boolean> function) throws com.aerospike.client.AerospikeException
      Find a record by specifying a class and a Boolean function.
      Specified by:
      find in interface IAeroMapper
      Parameters:
      clazz - - The type of the record.
      function - a Boolean function.
      Throws:
      com.aerospike.client.AerospikeException - an AerospikeException will be thrown in case of an error.

    • getClient

      public com.aerospike.client.IAerospikeClient getClient()
      Specified by:
      getClient in interface IAeroMapper

    • getMappingConverter

      public MappingConverter getMappingConverter()
      Specified by:
      getMappingConverter in interface IBaseAeroMapper

    • getReadPolicy

      public com.aerospike.client.policy.Policy getReadPolicy​(Class<?> clazz)
      Return the read policy to be used for the passed class. This is a convenience method only and should rarely be needed
      Specified by:
      getReadPolicy in interface IBaseAeroMapper
      Parameters:
      clazz - - the class to return the read policy for.
      Returns:
      - the appropriate read policy. If none is set, the client's readPolicyDefault is returned.

    • getWritePolicy

      public com.aerospike.client.policy.WritePolicy getWritePolicy​(Class<?> clazz)
      Return the write policy to be used for the passed class. This is a convenience method only and should rarely be needed
      Specified by:
      getWritePolicy in interface IBaseAeroMapper
      Parameters:
      clazz - - the class to return the write policy for.
      Returns:
      - the appropriate write policy. If none is set, the client's writePolicyDefault is returned.

    • getBatchPolicy

      public com.aerospike.client.policy.BatchPolicy getBatchPolicy​(Class<?> clazz)
      Return the batch policy to be used for the passed class. This is a convenience method only and should rarely be needed
      Specified by:
      getBatchPolicy in interface IBaseAeroMapper
      Parameters:
      clazz - - the class to return the batch policy for.
      Returns:
      - the appropriate batch policy. If none is set, the client's batchPolicyDefault is returned.

    • getScanPolicy

      public com.aerospike.client.policy.ScanPolicy getScanPolicy​(Class<?> clazz)
      Return the scan policy to be used for the passed class. This is a convenience method only and should rarely be needed
      Specified by:
      getScanPolicy in interface IBaseAeroMapper
      Parameters:
      clazz - - the class to return the scan policy for.
      Returns:
      - the appropriate scan policy. If none is set, the client's scanPolicyDefault is returned.

    • getQueryPolicy

      public com.aerospike.client.policy.QueryPolicy getQueryPolicy​(Class<?> clazz)
      Return the query policy to be used for the passed class. This is a convenience method only and should rarely be needed
      Specified by:
      getQueryPolicy in interface IBaseAeroMapper
      Parameters:
      clazz - - the class to return the query policy for.
      Returns:
      - the appropriate query policy. If none is set, the client's queryPolicyDefault is returned.

    • asMapper

      public IAeroMapper asMapper()
      Specified by:
      asMapper in interface IBaseAeroMapper