Class FileContentEntity
java.lang.Object
org.pentaho.reporting.libraries.repository.file.FileContentEntity
- All Implemented Interfaces:
Serializable
,ContentEntity
- Direct Known Subclasses:
FileContentItem
,FileContentLocation
A content-entity that uses a java.io.File as backend. The entity can read the
LibRepositoryBoot.SIZE_ATTRIBUTE
and can read and write the
LibRepositoryBoot.VERSION_ATTRIBUTE
.- Author:
- Thomas Morgner
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionboolean
delete()
Attempts to delete the entity.getAttribute
(String domain, String key) Returns a attribute value for the given domain (namespace) and attribute-name.Returns a unique identifier.getName()
Returns the name of the file.Returns a reference to the parent location.Returns the current repository, to which tis entity belongs.boolean
setAttribute
(String domain, String key, Object value) Updates the attribute value for the given attribute domain and name.
-
Method Details
-
getRepository
Returns the current repository, to which tis entity belongs.- Specified by:
getRepository
in interfaceContentEntity
- Returns:
- the repository.
-
getName
Returns the name of the file.- Specified by:
getName
in interfaceContentEntity
- Returns:
- the name, never null.
-
getContentId
Returns a unique identifier. This can be canonical filename or a database key. It must be guaranteed that within the same repository the key will be unique.- Specified by:
getContentId
in interfaceContentEntity
- Returns:
- the unique content ID.
-
getAttribute
Returns a attribute value for the given domain (namespace) and attribute-name. Some generic attribute domains and names are defined as constants in theLibRepositoryBoot
class.- Specified by:
getAttribute
in interfaceContentEntity
- Parameters:
domain
- the attribute domain.key
- the name of the attribute.- Returns:
- the value or null, if the content-entity does not have a value for this attribute.
-
setAttribute
Updates the attribute value for the given attribute domain and name. If the element is not writable or the attribute could not be updated for any other reason, the method will return false. This method only returns true, if the attribute has been updated successfully.- Specified by:
setAttribute
in interfaceContentEntity
- Parameters:
domain
- the attribute domain.key
- the attribute namevalue
- the new attribute value.- Returns:
- true, if the update was successful, false otherwise.
-
getParent
Returns a reference to the parent location. If this entity represents the root directory, this method will return null.- Specified by:
getParent
in interfaceContentEntity
- Returns:
- the parent or null, if this is the root-directory.
-
delete
public boolean delete()Attempts to delete the entity. After an entity has been deleted, any call to any of the methods of the entity may produce undefined results.- Specified by:
delete
in interfaceContentEntity
- Returns:
- true, if the entity was deleted and detached from the repository, false otherwise.
-