| org.pentaho.core.repository.IContentLocation
All known Subclasses: org.pentaho.repository.content.ContentLocation,
| IContentLocation | | public interface IContentLocation (Code) | | A Content location is analagous to a folder. It is the location of the content.
See Also: IContentItem
See Also: IContentRepository
author:
mbatchel |
| Method Summary | |
| public IContentItem | getContentItemById(String contentItemId)
| | public IContentItem | getContentItemByName(String name)
Gets a child content item by name. | | public IContentItem | getContentItemByPath(String path)
| | public Iterator | getContentItemIterator()
Iterates over registered content items. | | public String | getDescription()
| | public String | getDirPath()
| | public String | getId()
| | public String | getName()
| | public int | getRevision()
| | public String | getSolutionId()
| | public File | getTmpFile(String fileSuffix)
Gets a temporary file in the location.
Parameters:
fileSuffix - What the file suffix should be. | | public File | getTmpFile(String fileSuffix, boolean deleteOnExit)
Gets a temporary file in the location.
Parameters:
fileSuffix - What the file suffix should be. | | public File | makeSubdirectory(String subDirName)
Creates a subdirectory in the content location. | | public IContentItem | newContentItem(String name, String title, String extension, String mimeType, String url, int writeMode)
Create a new ContentItem parented to this content location.
Parameters:
name - The name of the content item
Parameters:
title - The title of the content item
Parameters:
extension - The extension (i.e. | | public IContentItem | newContentItem(String contentId, String name, String title, String extension, String mimeType, String url, int writeMode)
Create a new ContentItem parented to this content location. |
| getContentItemById | | public IContentItem getContentItemById(String contentItemId)(Code) | | Gets a content item by its Id - this is the most efficient way to get a
content item from a location
Parameters:
contentItemId - The id to retrieve The content item |
| getContentItemByName | | public IContentItem getContentItemByName(String name)(Code) | | Gets a child content item by name. Returns the ContentItem with the
specified name, and a parent of the content location
Parameters:
name - The name to find ContentItem |
| getContentItemByPath | | public IContentItem getContentItemByPath(String path)(Code) | | Returns the contentitem with the specified path
Parameters:
path - The path to look for The content item |
| getContentItemIterator | | public Iterator getContentItemIterator()(Code) | | Iterates over registered content items.
Iterator of the child content |
| getDescription | | public String getDescription()(Code) | | The description of the Content Location |
| getDirPath | | public String getDirPath()(Code) | | The directory path |
| getId | | public String getId()(Code) | | Returns the UUID of the content location |
| getName | | public String getName()(Code) | | The name of the content location |
| getRevision | | public int getRevision()(Code) | | The revision of the content item (as determined by Hibernate) |
| getSolutionId | | public String getSolutionId()(Code) | | The Solution Id |
| getTmpFile | | public File getTmpFile(String fileSuffix) throws ContentException(Code) | | Gets a temporary file in the location.
Parameters:
fileSuffix - What the file suffix should be. If null, then .tmp will beused. File that is unique within the directory inside this location.
throws:
ContentException - |
| getTmpFile | | public File getTmpFile(String fileSuffix, boolean deleteOnExit) throws ContentException(Code) | | Gets a temporary file in the location.
Parameters:
fileSuffix - What the file suffix should be. If null, then .tmp will beused.
Parameters:
deleteOnExit - If true, will call the files' deleteOnExit method which willattempt to delete the file on VM termination. File that is unique within the directory inside this location.
throws:
ContentException - |
| newContentItem | | public IContentItem newContentItem(String name, String title, String extension, String mimeType, String url, int writeMode) throws ContentException(Code) | | Create a new ContentItem parented to this content location.
Parameters:
name - The name of the content item
Parameters:
title - The title of the content item
Parameters:
extension - The extension (i.e. .txt or .pdf) of the content item.
Parameters:
mimeType - The mime type of the content item
Parameters:
url - Optional URL to get to the content.
Parameters:
writeMode - The write mode of the content item. Please see IContentItemfor valid write modes A new IContentItem instance, parented to the ContentLocation
throws:
ContentException - |
| newContentItem | | public IContentItem newContentItem(String contentId, String name, String title, String extension, String mimeType, String url, int writeMode) throws ContentException(Code) | | Create a new ContentItem parented to this content location. This version
is used when the content Id is already generated.
Parameters:
contentId - The Identifier for the new content item
Parameters:
name - The name of the content item
Parameters:
title - The title of the content item
Parameters:
extension - The extension (i.e. .txt or .pdf) of the content item.
Parameters:
mimeType - The mime type of the content item
Parameters:
url - Optional URL to get to the content.
Parameters:
writeMode - The write mode of the content item. Please see IContentItemfor valid write modes A new IContentItem instance, parented to the ContentLocation
throws:
ContentException - |
|
|