jetbrains.exodus.entitystore

Interface Entity

All Superinterfaces:

java.lang.Comparable<Entity>

public interface Entity
extends java.lang.Comparable<Entity>

Entity is an object in the EntityStore. Any Entity has type and unique id. Entity can have properties and blobs, and can be linked. Each property, blob or link is identified by its name. Although entity properties are expected to be Comparable, only Java primitives types, Strings and ComparableSet values can be used by default. Use registerCustomPropertyType() to define your own property type.

To create new entity, use StoreTransaction.newEntity(String):

     final Entity user = txn.newEntity("User");
 

To get unique if of and entity, use getId():

     final EntityId id = user.getId();
 

To get existing entity by id, use StoreTransaction.getEntity(EntityId):

     final Entity user = txn.getEntity(id);
 

See Also:

EntityStore, EntityId, StoreTransaction

Method Summary

Modifier and Type	Method and Description
boolean	addLink(@NotNull java.lang.String linkName, @NotNull Entity target) Adds link with specified name from this entity to specified entity.
boolean	addLink(@NotNull java.lang.String linkName, @NotNull EntityId targetId) Adds link with specified name from this entity to an entity with specified id.
boolean	delete() Deletes the entity unconditionally.
boolean	deleteBlob(@NotNull java.lang.String blobName) Deletes blob with specified name.
boolean	deleteLink(@NotNull java.lang.String linkName, @NotNull Entity target) Deletes the link with specified name to specified target.
boolean	deleteLink(@NotNull java.lang.String linkName, @NotNull EntityId targetId) Deletes the link with specified name to target with specified id.
void	deleteLinks(@NotNull java.lang.String linkName) Deletes links to all entities which this entity is linked by the link with specified name.
boolean	deleteProperty(@NotNull java.lang.String propertyName) Deletes property with specified name.
@Nullable java.io.InputStream	getBlob(@NotNull java.lang.String blobName) Gets value of blob with specified name as InputStream.
@NotNull java.util.List<java.lang.String>	getBlobNames() Returns names of all blobs of the entity.
long	getBlobSize(@NotNull java.lang.String blobName) Gets the size of blob with specified name.
@Nullable java.lang.String	getBlobString(@NotNull java.lang.String blobName) Gets value of blob with specified name as UTF8-encoded string.
@NotNull EntityId	getId()
@Nullable Entity	getLink(@NotNull java.lang.String linkName) Returns a single entity which this one is linked by link with specified name, or null if no such entity exists.
@NotNull java.util.List<java.lang.String>	getLinkNames() Returns names of all links of the entity.
@NotNull EntityIterable	getLinks(@NotNull java.util.Collection<java.lang.String> linkNames) Returns all entities which this one is linked by links with specified names.
@NotNull EntityIterable	getLinks(@NotNull java.lang.String linkName) Returns all entities which this one is linked by the link with specified name.
@Nullable java.lang.Comparable	getProperty(@NotNull java.lang.String propertyName) Gets value of property with specified name.
@NotNull java.util.List<java.lang.String>	getPropertyNames() Returns names of all properties of the entity.
@Nullable ByteIterable	getRawProperty(@NotNull java.lang.String propertyName) Gets raw value of the property with specified name.
@NotNull EntityStore	getStore()
@NotNull java.lang.String	getType()
void	setBlob(@NotNull java.lang.String blobName, @NotNull java.io.File file) Sets value (as contents of File) of blob with specified name.
void	setBlob(@NotNull java.lang.String blobName, @NotNull java.io.InputStream blob) Sets value (as InputStream) of blob with specified name.
boolean	setBlobString(@NotNull java.lang.String blobName, @NotNull java.lang.String blobString) Sets value (as String encoded in UTF-8) of blob with specified name.
boolean	setLink(@NotNull java.lang.String linkName, @Nullable Entity target) Links this entity with target one by link with specified name.
boolean	setLink(@NotNull java.lang.String linkName, @NotNull EntityId targetId) Links this entity with target with specified id by link with specified name.
boolean	setProperty(@NotNull java.lang.String propertyName, @NotNull java.lang.Comparable value) Sets property with specified name to specified value.
@NotNull java.lang.String	toIdString()

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getStore

@NotNull
@NotNull EntityStore getStore()

Returns:

instance of EntityStore against which the entity was created

getId

@NotNull
@NotNull EntityId getId()

Returns:

unique id of the entity

toIdString

@NotNull
@NotNull java.lang.String toIdString()

Returns:

string representation of the entity unique id.

See Also:

StoreTransaction.toEntityId(String)

getType

@NotNull
@NotNull java.lang.String getType()

Returns:

entity type

delete

boolean delete()

Deletes the entity unconditionally.

Returns:

true if the entity was deleted, otherwise it didn't exist

getRawProperty

@Nullable
@Nullable ByteIterable getRawProperty(@NotNull
                                                @NotNull java.lang.String propertyName)

Gets raw value of the property with specified name.

Parameters:

propertyName - name of the property

Returns:

property raw value, or null if the property is not set

See Also:

ByteIterable, getProperty(String), setProperty(String, Comparable), deleteProperty(String), getPropertyNames()

getProperty

@Nullable
@Nullable java.lang.Comparable getProperty(@NotNull
                                                     @NotNull java.lang.String propertyName)

Gets value of property with specified name.

Parameters:

propertyName - name of the property

Returns:

property value, or null if the property is not set

See Also:

getRawProperty(String), setProperty(String, Comparable), deleteProperty(String), getPropertyNames()

setProperty

boolean setProperty(@NotNull
                    @NotNull java.lang.String propertyName,
                    @NotNull
                    @NotNull java.lang.Comparable value)

Sets property with specified name to specified value. If the property value is equal to false, it is the same as calling deleteProperty(String).

Parameters:

propertyName - name of the property

value - property value

Returns:

true if value was actually set, i.e. if it is not equal to the old value

See Also:

getProperty(String), getRawProperty(String), deleteProperty(String), getPropertyNames()

deleteProperty

boolean deleteProperty(@NotNull
                       @NotNull java.lang.String propertyName)

Deletes property with specified name.

Parameters:

propertyName - name of the property

Returns:

true if the property was actually deleted, otherwise it didn't exist

See Also:

getProperty(String), getRawProperty(String), setProperty(String, Comparable), getPropertyNames()

getPropertyNames

@NotNull
@NotNull java.util.List<java.lang.String> getPropertyNames()

Returns names of all properties of the entity.

Returns:

list of property names

See Also:

getProperty(String), getRawProperty(String), setProperty(String, Comparable), deleteProperty(String)

getBlob

@Nullable
@Nullable java.io.InputStream getBlob(@NotNull
                                                @NotNull java.lang.String blobName)

Gets value of blob with specified name as InputStream. You are not required to and should not close the input stream that is returned by the method.

Parameters:

blobName - name of the blob

Returns:

blob stream, or null if the blob is not set

See Also:

getBlobSize(String), getBlobString(String), setBlob(String, InputStream), setBlob(String, File), setBlobString(String, String), deleteBlob(String)

getBlobSize

long getBlobSize(@NotNull
                 @NotNull java.lang.String blobName)

Gets the size of blob with specified name.

Parameters:

blobName - name of the blob

Returns:

blob size, or negative value if the blob is not set

See Also:

getBlob(String), getBlobString(String), setBlob(String, InputStream), setBlob(String, File), setBlobString(String, String), deleteBlob(String)

getBlobString

@Nullable
@Nullable java.lang.String getBlobString(@NotNull
                                                   @NotNull java.lang.String blobName)

Gets value of blob with specified name as UTF8-encoded string.

Parameters:

blobName - name of the blob

Returns:

blob string, or null if the blob is not set

See Also:

getBlob(String), getBlobSize(String), UTFUtil.readUTF(InputStream), setBlob(String, InputStream), setBlob(String, File), setBlobString(String, String), deleteBlob(String)

setBlob

void setBlob(@NotNull
             @NotNull java.lang.String blobName,
             @NotNull
             @NotNull java.io.InputStream blob)

Sets value (as InputStream) of blob with specified name. For large blobs (having size greater than PersistentEntityStoreConfig.getMaxInPlaceBlobSize() which is by default 10000), it is preferable to use setBlob(String, File) instead.

Parameters:

blobName - name of the blob

blob - blob value as InputStream

See Also:

getBlob(String), getBlobSize(String), getBlobString(String), setBlob(String, File), setBlobString(String, String), deleteBlob(String), PersistentEntityStoreConfig.getMaxInPlaceBlobSize()

setBlob

void setBlob(@NotNull
             @NotNull java.lang.String blobName,
             @NotNull
             @NotNull java.io.File file)

Sets value (as contents of File) of blob with specified name. For large blobs (having size larger than PersistentEntityStoreConfig.getMaxInPlaceBlobSize() which is by default 10000), using this method is preferable, because (in case if the database location and file exists on a common physical partition) it can succeed by just renaming the file instead of copying.

Parameters:

blobName - name of the blob

file - blob value as InputStream

See Also:

getBlob(String), getBlobSize(String), getBlobString(String), setBlob(String, File), setBlobString(String, String), deleteBlob(String), PersistentEntityStoreConfig.getMaxInPlaceBlobSize()

setBlobString

boolean setBlobString(@NotNull
                      @NotNull java.lang.String blobName,
                      @NotNull
                      @NotNull java.lang.String blobString)

Sets value (as String encoded in UTF-8) of blob with specified name.

Parameters:

blobName - name of the blob

blobString - blob value

Returns:

true if blobString is not equal to old value

See Also:

getBlob(String), getBlobSize(String), getBlobString(String), UTFUtil.readUTF(InputStream), setBlob(String, InputStream), setBlob(String, File), deleteBlob(String)

deleteBlob

boolean deleteBlob(@NotNull
                   @NotNull java.lang.String blobName)

Deletes blob with specified name.

Parameters:

blobName - name of the blob

Returns:

true if the blob was actually deleted, otherwise it didn't exist

See Also:

getBlob(String), getBlobSize(String), getBlobString(String), setBlob(String, InputStream), setBlob(String, File), setBlobString(String, String)

getBlobNames

@NotNull
@NotNull java.util.List<java.lang.String> getBlobNames()

Returns names of all blobs of the entity.

Returns:

list of blob names

See Also:

getBlob(String), getBlobSize(String), getBlobString(String), setBlob(String, InputStream), setBlob(String, File), setBlobString(String, String), deleteBlob(String)

addLink

boolean addLink(@NotNull
                @NotNull java.lang.String linkName,
                @NotNull
                @NotNull Entity target)

Adds link with specified name from this entity to specified entity. If there is a link with the same name to another target, it is not affected.

Parameters:

linkName - name of the link

target - entity to link with

Returns:

true if the link didn't exist

See Also:

addLink(String, EntityId), getLink(String), getLinks(String), getLinks(Collection), setLink(String, Entity), setLink(String, EntityId), deleteLink(String, Entity), deleteLink(String, EntityId), deleteLinks(String), getLinkNames()

addLink

boolean addLink(@NotNull
                @NotNull java.lang.String linkName,
                @NotNull
                @NotNull EntityId targetId)

Adds link with specified name from this entity to an entity with specified id. If there is a link with the same name to another target, it is not affected. If target with specified id doest't exist nothing happens, and the method returns false.

Parameters:

linkName - name of the link

targetId - id of entity to link with

Returns:

true if target exists and the link didn't exist

See Also:

addLink(String, EntityId), getLink(String), getLinks(String), getLinks(Collection), setLink(String, Entity), setLink(String, EntityId), deleteLink(String, Entity), deleteLink(String, EntityId), deleteLinks(String), getLinkNames()

getLink

@Nullable
@Nullable Entity getLink(@NotNull
                                   @NotNull java.lang.String linkName)

Returns a single entity which this one is linked by link with specified name, or null if no such entity exists.

Parameters:

linkName - name of the link

Returns:

linked entity or or null if it doesn't exist

See Also:

addLink(String, Entity), addLink(String, EntityId), getLinks(String), getLinks(Collection), setLink(String, Entity), setLink(String, EntityId), deleteLink(String, Entity), deleteLink(String, EntityId), deleteLinks(String), getLinkNames()

setLink

boolean setLink(@NotNull
                @NotNull java.lang.String linkName,
                @Nullable
                @Nullable Entity target)

Links this entity with target one by link with specified name. Unlike addLink(String, Entity), the method doesn't add new target if any with the same link already exists, but overrides the old target. So there can be only 0 or 1 link with specified name set by this method.

Parameters:

linkName - name of the link

target - entity to link with

Returns:

true if target is not equal to old target

See Also:

addLink(String, Entity), addLink(String, EntityId), getLink(String), getLinks(String), getLinks(Collection), setLink(String, EntityId), deleteLink(String, Entity), deleteLink(String, EntityId), deleteLinks(String), getLinkNames()

setLink

boolean setLink(@NotNull
                @NotNull java.lang.String linkName,
                @NotNull
                @NotNull EntityId targetId)

Links this entity with target with specified id by link with specified name. Unlike addLink(String, EntityId), the method doesn't add new target if any with the same link already exists, but overrides the old target. So there can be only 0 or 1 link with specified name set by this method.

Parameters:

linkName - name of the link

targetId - id of entity to link with

Returns:

true if target with specified id exists and is not equal to old target

See Also:

addLink(String, Entity), addLink(String, EntityId), getLink(String), getLinks(String), getLinks(Collection), setLink(String, Entity), deleteLink(String, Entity), deleteLink(String, EntityId), deleteLinks(String), getLinkNames()

getLinks

@NotNull
@NotNull EntityIterable getLinks(@NotNull
                                          @NotNull java.lang.String linkName)

Returns all entities which this one is linked by the link with specified name.

Parameters:

linkName - name of the link

Returns:

EntityIterable

See Also:

addLink(String, Entity), addLink(String, EntityId), getLink(String), getLinks(Collection), setLink(String, Entity), setLink(String, EntityId), deleteLink(String, Entity), deleteLink(String, EntityId), deleteLinks(String), getLinkNames()

getLinks

@NotNull
@NotNull EntityIterable getLinks(@NotNull
                                          @NotNull java.util.Collection<java.lang.String> linkNames)

Returns all entities which this one is linked by links with specified names.

Parameters:

linkNames - collection of link names

Returns:

EntityIterable

See Also:

addLink(String, Entity), addLink(String, EntityId), getLink(String), getLinks(String), setLink(String, Entity), setLink(String, EntityId), deleteLink(String, Entity), deleteLink(String, EntityId), deleteLinks(String), getLinkNames()

deleteLink

boolean deleteLink(@NotNull
                   @NotNull java.lang.String linkName,
                   @NotNull
                   @NotNull Entity target)

Deletes the link with specified name to specified target.

Parameters:

linkName - name of the link

target - linked target

Returns:

true if the link was actually deleted, otherwise it didn't exist

See Also:

addLink(String, Entity), addLink(String, EntityId), getLink(String), getLinks(String), getLinks(Collection), setLink(String, Entity), setLink(String, EntityId), deleteLink(String, EntityId), deleteLinks(String), getLinkNames()

deleteLink

boolean deleteLink(@NotNull
                   @NotNull java.lang.String linkName,
                   @NotNull
                   @NotNull EntityId targetId)

Deletes the link with specified name to target with specified id. If target doesn't exist returns false.

Parameters:

linkName - name of the link

targetId - id of linked target

Returns:

true if target with specified id exists and the link was actually deleted, otherwise it didn't exist

See Also:

addLink(String, Entity), addLink(String, EntityId), getLink(String), getLinks(String), getLinks(Collection), setLink(String, Entity), setLink(String, EntityId), deleteLink(String, Entity), deleteLinks(String), getLinkNames()

deleteLinks

void deleteLinks(@NotNull
                 @NotNull java.lang.String linkName)

Deletes links to all entities which this entity is linked by the link with specified name.

Parameters:

linkName - name of the link

See Also:

addLink(String, Entity), addLink(String, EntityId), getLink(String), getLinks(String), getLinks(Collection), setLink(String, Entity), setLink(String, EntityId), deleteLink(String, Entity), deleteLink(String, EntityId), getLinkNames()

getLinkNames

@NotNull
@NotNull java.util.List<java.lang.String> getLinkNames()

Returns names of all links of the entity.

Returns:

list of link names

See Also:

addLink(String, Entity), addLink(String, EntityId), getLink(String), getLinks(String), getLinks(Collection), setLink(String, Entity), setLink(String, EntityId), deleteLink(String, Entity), deleteLink(String, EntityId), deleteLinks(String)