public class DSFileSpec
extends java.lang.Object | Constructor and Description | 
|---|
| DSFileSpec(java.util.Map record)Specify a file from a Map specifying one or more of fileName, fileType and fileFormat. | 
| DSFileSpec(java.lang.String url)Construct a DSFileSpec from a URL-like string. | 
| DSFileSpec(java.lang.String url, DSRequest request)Construct a DSFileSpec from a URL-like string. | 
| DSFileSpec(java.lang.String dsName, java.util.Map record)Specify a file from a dsName and a Map specifying one or more of fileName, fileType and fileFormat. | 
| DSFileSpec(java.lang.String dsName, java.util.Map record, DSRequest request)Specify a file from a dsName and a Map specifying one or more of fileName, fileType and fileFormat. | 
| DSFileSpec(java.lang.String dsName, java.lang.String dsFileName)Specify a file with the given DataSource name and filename, without specifying a fileType or fileFormat. | 
| DSFileSpec(java.lang.String dsName, java.lang.String dsFileName, java.lang.String dsFileType)Specify a file with the given DataSource name, filename, and fileType, without specifying a fileFormat. | 
| DSFileSpec(java.lang.String dsName, java.lang.String dsFileName, java.lang.String dsFileType, java.lang.String dsFileFormat)Specify a file with the given DataSource name, filename, fileType, and fileFormat. | 
| DSFileSpec(java.lang.String dsName, java.lang.String dsFileName, java.lang.String dsFileType, java.lang.String dsFileFormat, DSRequest request)Specify a file with the given DataSource name, filename, fileType, fileFormat and requestContext. | 
| Modifier and Type | Method and Description | 
|---|---|
| java.lang.String | getDataSourceName() | 
| java.lang.String | getFileFormat() | 
| java.lang.String | getFileName() | 
| java.lang.String | getFileType() | 
| java.lang.String | getOwnerId() | 
| DSRequest | getRequestContext() | 
| void | setDataSourceName(java.lang.String name) | 
| void | setFileFormat(java.lang.String format) | 
| void | setFileName(java.lang.String name) | 
| void | setFileType(java.lang.String type) | 
| void | setOwnerId(java.lang.String ownerId) | 
| void | setRequestContext(DSRequest context) | 
public DSFileSpec(java.lang.String dsName,
                  java.lang.String dsFileName) dsName - The name of the DataSourcedsFileName - The name of the file, without any extension for type or formatpublic DSFileSpec(java.lang.String dsName,
                  java.lang.String dsFileName,
                  java.lang.String dsFileType) dsName - The name of the DataSourcedsFileName - The name of the file, without any extension for type or formatdsFileType - The fileType (e.g. "ds" for datasource)public DSFileSpec(java.lang.String dsName,
                  java.lang.String dsFileName,
                  java.lang.String dsFileType,
                  java.lang.String dsFileFormat) dsName - The name of the DataSourcedsFileName - The name of the file, without any extension for type or formatdsFileType - The fileType (e.g. "ds" for datasource)dsFileFormat - The fileFormat (e.g. "xml" or "js")public DSFileSpec(java.lang.String dsName,
                  java.lang.String dsFileName,
                  java.lang.String dsFileType,
                  java.lang.String dsFileFormat,
                  DSRequest request) dsName - The name of the DataSourcedsFileName - The name of the file, without any extension for type or formatdsFileType - The fileType (e.g. "ds" for datasource)dsFileFormat - The fileFormat (e.g. "xml" or "js")request - The DSRequest which provides security context for this DSFileSpec.public DSFileSpec(java.util.Map record)
record - A Map specifying one or more of fileName, fileType and fileFormat.public DSFileSpec(java.lang.String dsName,
                  java.util.Map record) dsName - The name of the DataSourcerecord - A Map specifying one or more of fileName, fileType and fileFormat.public DSFileSpec(java.lang.String dsName,
                  java.util.Map record,
                  DSRequest request) dsName - The name of the DataSourcerecord - A Map specifying one or more of fileName, fileType and fileFormat.request - The DSRequest which provides security context for this DSFileSpec.public DSFileSpec(java.lang.String url)
url - URL-like specification for the file. To specify both the dsName and the filename, use a URL that looks like ds://datasourceName/fileName.type.format -- e.g. "ds://projects/bigProject.proj.xml"). Note that the fileType and fileFormat should not have any spaces.
If you want a DSFileSpec that only parses the filename, then just specify the filename, like this "fileName.type.format".
public DSFileSpec(java.lang.String url,
                  DSRequest request) url - URL-like specification for the file.request - The DSRequest which provides security context for this DSFileSpec. To specify both the dsName and the filename, use a URL that looks like ds://datasourceName/fileName.type.format -- e.g. "ds://projects/bigProject.proj.xml"). Note that the fileType and fileFormat should not have any spaces.
If you want a DSFileSpec that only parses the filename, then just specify the filename, like this "fileName.type.format".
public java.lang.String getDataSourceName()
DataSource in which to find the filepublic void setDataSourceName(java.lang.String name)
name - The name of the DataSource in which to find the filepublic DSRequest getRequestContext()
public void setRequestContext(DSRequest context)
context - The DSRequest which provides security context for this DSFileSpec.public java.lang.String getFileName()
public void setFileName(java.lang.String name)
name - The fileName, without any extension for type or format.public java.lang.String getFileType()
public void setFileType(java.lang.String type)
type - The fileType, e.g. "ds"public java.lang.String getFileFormat()
public void setFileFormat(java.lang.String format)
format - The fileFormat, e.g. "xml" or "js"public java.lang.String getOwnerId()
public void setOwnerId(java.lang.String ownerId)
ownerId - The ownerId