类 org.opencms.file.CmsFile
的使用

使用CmsFile的程序包

程序包	说明
org.opencms.ade.containerpage
org.opencms.ade.containerpage.inherited
org.opencms.ade.contenteditor
org.opencms.db	Low-level database connection and access functionality.
org.opencms.db.generic	Generic (ANSI-SQL) implementation of the OpenCms database connector.
org.opencms.db.jpa
org.opencms.file	This important package provides the methods to access the OpenCms VFS repository with the permissions of an authenticated user.
org.opencms.file.history	This package contains the classes to deal with the OpenCms VFS history archive.
org.opencms.file.types	The implementations of the core resource types for the VFS are located here.
org.opencms.file.wrapper	This package contains classes and interfaces used to access OpenCms through a wrapped CmsObject.
org.opencms.importexport	Contains functions to import and export resources from the OpenCms VFS.
org.opencms.jlan
org.opencms.jsp.util	Utility classes to be used for JSP pages.
org.opencms.loader	Low-level functions to manage the loading of resources from the OpenCms VFS.
org.opencms.relations	Classes to represent and validate the internal and external links/relations of resources in the OpenCms VFS.
org.opencms.search.documents	Handles indexing different sorts of document and resource type from the OpenCms VFS for the full text search.
org.opencms.workplace.comparison	Contains OpenCms Workplace dialogs to compare OpenCms Xml Documents.
org.opencms.workplace.editors	Base classes for the editors (WYSIWYG, plain text, XML content) used in the OpenCms Workplace.
org.opencms.workplace.editors.directedit	Used to control the generation of the HTML for the "direct edit" buttons.
org.opencms.xml	Basic XML functionality and utilities used by OpenCms to maintain XML documents and content.
org.opencms.xml.containerpage	Contains functions for the ADE main pages, commonly called "Container Pages" in OpenCms.
org.opencms.xml.content	Contains functions for structured content storage using XML, commonly called "XML content" in OpenCms.
org.opencms.xml.page	Contains functions for unstructured content storage using XML, commonly called "XML pages" in OpenCms.

org.opencms.ade.containerpage中CmsFile的使用

参数类型为CmsFile的org.opencms.ade.containerpage中的方法

限定符和类型	方法和说明
java.lang.String	CmsElementUtil.getContentByContainer(CmsFile elementFile, java.lang.String elementId, CmsContainer container) Returns the HTML content for the given resource and container.

org.opencms.ade.containerpage.inherited中CmsFile的使用

参数类型为CmsFile的org.opencms.ade.containerpage.inherited中的方法

限定符和类型	方法和说明
void	CmsContainerConfigurationParser.parse(CmsFile file) Parses the contents of a file.

org.opencms.ade.contenteditor中CmsFile的使用

参数类型为CmsFile的org.opencms.ade.contenteditor中的构造器

构造器和说明
CmsContentTypeVisitor(CmsObject cms, CmsFile file, java.util.Locale locale) Constructor.

org.opencms.db中CmsFile的使用

返回CmsFile的org.opencms.db中的方法

限定符和类型	方法和说明
CmsFile	I_CmsVfsDriver.createFile(java.sql.ResultSet res, CmsUUID projectId) Creates a CmsFile instance from a JDBC ResultSet.
CmsFile	I_CmsVfsDriver.createFile(java.sql.ResultSet res, CmsUUID projectId, boolean hasFileContentInResultSet) Creates a CmsFile instance from a JDBC ResultSet.
CmsFile	I_CmsProjectDriver.publishFileContent(CmsDbContext dbc, CmsProject offlineProject, CmsProject onlineProject, CmsResource offlineFileHeader, java.util.Set<CmsUUID> publishedResourceIds, boolean needToUpdateContent, int publishTag) Publishes the content record of a file.
CmsFile	CmsDriverManager.readFile(CmsDbContext dbc, CmsResource resource) Reads a file resource (including it's binary content) from the VFS, using the specified resource filter.
CmsFile	CmsSecurityManager.readFile(CmsRequestContext context, CmsResource resource) Reads a file resource (including it's binary content) from the VFS.
CmsFile	CmsDriverManager.writeFile(CmsDbContext dbc, CmsFile resource) Writes a resource to the OpenCms VFS, including it's content.
CmsFile	CmsSecurityManager.writeFile(CmsRequestContext context, CmsFile resource) Writes a resource to the OpenCms VFS, including it's content.

参数类型为CmsFile的org.opencms.db中的方法

限定符和类型	方法和说明
CmsFile	CmsDriverManager.writeFile(CmsDbContext dbc, CmsFile resource) Writes a resource to the OpenCms VFS, including it's content.
CmsFile	CmsSecurityManager.writeFile(CmsRequestContext context, CmsFile resource) Writes a resource to the OpenCms VFS, including it's content.

org.opencms.db.generic中CmsFile的使用

返回CmsFile的org.opencms.db.generic中的方法

限定符和类型	方法和说明
CmsFile	CmsVfsDriver.createFile(java.sql.ResultSet res, CmsUUID projectId)
CmsFile	CmsVfsDriver.createFile(java.sql.ResultSet res, CmsUUID projectId, boolean hasFileContentInResultSet)
CmsFile	CmsProjectDriver.publishFileContent(CmsDbContext dbc, CmsProject offlineProject, CmsProject onlineProject, CmsResource offlineResource, java.util.Set<CmsUUID> publishedResourceIds, boolean needToUpdateContent, int publishTag)

org.opencms.db.jpa中CmsFile的使用

返回CmsFile的org.opencms.db.jpa中的方法

限定符和类型	方法和说明
CmsFile	CmsVfsDriver.createFile(java.lang.Object[] o, CmsUUID projectId, boolean hasFileContentInResultSet) Creates a CmsFile instance from a jpa ResultSet.
CmsFile	CmsVfsDriver.createFile(java.sql.ResultSet res, CmsUUID projectId)
CmsFile	CmsVfsDriver.createFile(java.sql.ResultSet res, CmsUUID projectId, boolean hasFileContentInResultSet)
CmsFile	CmsProjectDriver.publishFileContent(CmsDbContext dbc, CmsProject offlineProject, CmsProject onlineProject, CmsResource offlineResource, java.util.Set<CmsUUID> publishedResourceIds, boolean needToUpdateContent, int publishTag)

org.opencms.file中CmsFile的使用

返回CmsFile的org.opencms.file中的方法

限定符和类型	方法和说明
CmsFile	CmsObject.readFile(CmsResource resource) Reads a file resource (including it's binary content) from the VFS, for the given resource (this may also be an historical version of the resource).
CmsFile	CmsObject.readFile(java.lang.String resourcename) Reads a file resource (including it's binary content) from the VFS, using the CmsResourceFilter.DEFAULT filter.
CmsFile	CmsObject.readFile(java.lang.String resourcename, CmsResourceFilter filter) Reads a file resource (including it's binary content) from the VFS, using the specified resource filter.
CmsFile	CmsObject.writeFile(CmsFile resource) Writes a resource to the OpenCms VFS, including it's content.

参数类型为CmsFile的org.opencms.file中的方法

限定符和类型	方法和说明
protected CmsPair<java.lang.String,java.lang.String>	CmsLinkRewriter.decode(CmsFile file) Decodes a file's contents and return the content string and the encoding to use for writing the file back to the VFS.
protected void	CmsLinkRewriter.rewriteContent(CmsFile file, java.util.Collection<CmsRelation> relations) Rewrites the links included in the content itself.
CmsFile	CmsObject.writeFile(CmsFile resource) Writes a resource to the OpenCms VFS, including it's content.

org.opencms.file.history中CmsFile的使用

org.opencms.file.history中CmsFile的子类

限定符和类型	类和说明
class	CmsHistoryFile A historical version of a file in the OpenCms VFS resource history.

org.opencms.file.types中CmsFile的使用

返回CmsFile的org.opencms.file.types中的方法

限定符和类型	方法和说明
CmsFile	CmsResourceTypeXmlPage.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypeXmlContent.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	I_CmsResourceType.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) Writes a resource, including it's content.
CmsFile	CmsResourceTypeImage.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypeJsp.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	A_CmsResourceType.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypePlain.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypeXmlContainerPage.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)

参数类型为CmsFile的org.opencms.file.types中的方法

限定符和类型	方法和说明
java.util.List<CmsLink>	CmsResourceTypeXmlPage.parseLinks(CmsObject cms, CmsFile file)
java.util.List<CmsLink>	CmsResourceTypeXmlContent.parseLinks(CmsObject cms, CmsFile file)
java.util.List<CmsLink>	CmsResourceTypeJsp.parseLinks(CmsObject cms, CmsFile file)
java.util.List<CmsLink>	CmsResourceTypeXmlContainerPage.parseLinks(CmsObject cms, CmsFile file)
CmsFile	CmsResourceTypeXmlPage.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypeXmlContent.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	I_CmsResourceType.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) Writes a resource, including it's content.
CmsFile	CmsResourceTypeImage.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypeJsp.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	A_CmsResourceType.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypePlain.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypeXmlContainerPage.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)

org.opencms.file.wrapper中CmsFile的使用

返回CmsFile的org.opencms.file.wrapper中的方法

限定符和类型	方法和说明
static CmsFile	CmsResourceWrapperUtils.createPropertyFile(CmsObject cms, CmsResource res, java.lang.String path) Creates a virtual CmsFile with the individual and shared properties as content.
CmsFile	CmsWrappedResource.getFile() Returns the virtual resource as a file.
CmsFile	I_CmsResourceWrapper.readFile(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter) Reads a file resource (including it's binary content) from the VFS, using the specified resource filter.
CmsFile	CmsResourceWrapperPropertyFile.readFile(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
CmsFile	CmsResourceWrapperXmlPage.readFile(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
CmsFile	A_CmsResourceWrapper.readFile(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
CmsFile	A_CmsResourceExtensionWrapper.readFile(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
CmsFile	CmsObjectWrapper.readFile(java.lang.String resourcename, CmsResourceFilter filter) Reads a file resource (including it's binary content) from the VFS, using the specified resource filter.
CmsFile	CmsObjectWrapper.writeFile(CmsFile resource) Writes a resource to the OpenCms VFS, including it's content.
CmsFile	I_CmsResourceWrapper.writeFile(CmsObject cms, CmsFile resource) Writes a resource, including it's content.
CmsFile	CmsResourceWrapperPropertyFile.writeFile(CmsObject cms, CmsFile resource)
CmsFile	CmsResourceWrapperXmlPage.writeFile(CmsObject cms, CmsFile resource)
CmsFile	A_CmsResourceWrapper.writeFile(CmsObject cms, CmsFile resource)
CmsFile	A_CmsResourceExtensionWrapper.writeFile(CmsObject cms, CmsFile resource)

参数类型为CmsFile的org.opencms.file.wrapper中的方法

限定符和类型	方法和说明
CmsFile	CmsObjectWrapper.writeFile(CmsFile resource) Writes a resource to the OpenCms VFS, including it's content.
CmsFile	I_CmsResourceWrapper.writeFile(CmsObject cms, CmsFile resource) Writes a resource, including it's content.
CmsFile	CmsResourceWrapperPropertyFile.writeFile(CmsObject cms, CmsFile resource)
CmsFile	CmsResourceWrapperXmlPage.writeFile(CmsObject cms, CmsFile resource)
CmsFile	A_CmsResourceWrapper.writeFile(CmsObject cms, CmsFile resource)
CmsFile	A_CmsResourceExtensionWrapper.writeFile(CmsObject cms, CmsFile resource)

org.opencms.importexport中CmsFile的使用

参数类型为CmsFile的org.opencms.importexport中的方法

限定符和类型	方法和说明
protected void	CmsExport.exportFile(CmsFile file) Exports one single file with all its data and content.
void	CmsExportHelper.writeFile(CmsFile file, java.lang.String name) Writes a single OpenCms VFS file to the export.
protected void	CmsExportHelper.writeFile2Rfs(CmsFile file, java.lang.String name) Writes a single OpenCms VFS file to the RFS export.
protected void	CmsExportHelper.writeFile2Zip(CmsFile file, java.lang.String name) Writes a single OpenCms VFS file to the ZIP export.

org.opencms.jlan中CmsFile的使用

返回CmsFile的org.opencms.jlan中的方法

限定符和类型	方法和说明
protected CmsFile	CmsJlanNetworkFile.getFile() Gets the CmsFile instance for this file, or null if the file contents haven'T been loaded already.

org.opencms.jsp.util中CmsFile的使用

返回CmsFile的org.opencms.jsp.util中的方法

限定符和类型	方法和说明
CmsFile	CmsJspContentAccessBean.getFile() Returns the raw VFS file object the content accessed by this bean was created from.
CmsFile	CmsJspResourceAccessBean.getFile() Returns the raw VFS file object of the current resource.

org.opencms.loader中CmsFile的使用

返回CmsFile的org.opencms.loader中的方法

限定符和类型	方法和说明
protected CmsFile	CmsImageLoader.getScaledImage(CmsObject cms, CmsResource resource, CmsImageScaler scaler) Returns a scaled version of the given OpenCms VFS image resource.

参数类型为CmsFile的org.opencms.loader中的方法

限定符和类型	方法和说明
byte[]	CmsImageScaler.scaleImage(CmsFile file) Returns a scaled version of the given image file according this image scalers parameters.

org.opencms.relations中CmsFile的使用

参数类型为CmsFile的org.opencms.relations中的方法

限定符和类型	方法和说明
java.util.List<CmsLink>	I_CmsLinkParseable.parseLinks(CmsObject cms, CmsFile file) Returns a list of all links from the specified file.

org.opencms.search.documents中CmsFile的使用

返回CmsFile的org.opencms.search.documents中的方法

限定符和类型	方法和说明
protected CmsFile	A_CmsVfsDocument.readFile(CmsObject cms, CmsResource resource) Upgrades the given resource to a CmsFile with content.

org.opencms.workplace.comparison中CmsFile的使用

返回CmsFile的org.opencms.workplace.comparison中的方法

限定符和类型	方法和说明
protected static CmsFile	CmsAttributeComparisonList.readFile(CmsObject cms, CmsUUID structureId, java.lang.String version) Returns either the historical file or the offline file, depending on the version number.
protected static CmsFile	CmsResourceComparisonDialog.readFile(CmsObject cms, CmsUUID structureId, java.lang.String version) Returns either the historical file or the offline file, depending on the version number.

参数类型为CmsFile的org.opencms.workplace.comparison中的构造器

构造器和说明
CmsXmlDocumentComparison(CmsObject cms, CmsFile res1, CmsFile res2) Creates a new xml document comparison.

org.opencms.workplace.editors中CmsFile的使用

声明为CmsFile的org.opencms.workplace.editors中的字段

限定符和类型	字段和说明
protected CmsFile	CmsDefaultPageEditor.m_file File object used to read and write contents.

参数类型为CmsFile的org.opencms.workplace.editors中的方法

限定符和类型	方法和说明
protected java.lang.String	CmsSimpleEditor.decodeContentParameter(java.lang.String encodedContent, java.lang.String encoding, CmsFile originalFile) Decodes the content from the content request parameter.

org.opencms.workplace.editors.directedit中CmsFile的使用

参数类型为CmsFile的org.opencms.workplace.editors.directedit中的方法

限定符和类型	方法和说明
protected java.lang.String	CmsDirectEditDefaultProvider.getContentAsString(CmsFile file) Helper method to convert the content of a resource to a string.

org.opencms.xml中CmsFile的使用

声明为CmsFile的org.opencms.xml中的字段

限定符和类型	字段和说明
protected CmsFile	A_CmsXmlDocument.m_file The file that contains the document data (note: is not set when creating an empty or document based document).

返回CmsFile的org.opencms.xml中的方法

限定符和类型	方法和说明
CmsFile	A_CmsXmlDocument.correctXmlStructure(CmsObject cms) Corrects the structure of this XML document.
CmsFile	I_CmsXmlDocument.getFile() Returns the file this document was generated from, may be null if the file not available.
CmsFile	A_CmsXmlDocument.getFile()

org.opencms.xml.containerpage中CmsFile的使用

参数类型为CmsFile的org.opencms.xml.containerpage中的方法

限定符和类型	方法和说明
protected void	CmsXmlContainerPage.setFile(CmsFile file)
protected void	CmsXmlGroupContainer.setFile(CmsFile file)
void	CmsContainerElementBean.setTemporaryFile(CmsFile elementFile) Sets the element resource as a temporary file.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.unmarshal(CmsObject cms, CmsFile file) Factory method to unmarshal (read) a group container instance from a OpenCms VFS file that contains XML data.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, CmsFile file) Factory method to unmarshal (read) a container page instance from a OpenCms VFS file that contains XML data.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding) Factory method to unmarshal (read) a group container instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding) Factory method to unmarshal (read) a container page instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding, boolean noCache) Factory method to unmarshal (read) a container page instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.

org.opencms.xml.content中CmsFile的使用

返回CmsFile的org.opencms.xml.content中的方法

限定符和类型	方法和说明
CmsFile	I_CmsXmlContentHandler.prepareForWrite(CmsObject cms, CmsXmlContent content, CmsFile file) Prepares the given XML content to be written to the OpenCms VFS.
CmsFile	CmsDefaultXmlContentHandler.prepareForWrite(CmsObject cms, CmsXmlContent content, CmsFile file)
protected CmsFile	CmsDefaultXmlContentHandler.writeCategories(CmsObject cms, CmsFile file, CmsXmlContent content) Writes the categories if a category widget is present.

参数类型为CmsFile的org.opencms.xml.content中的方法

限定符和类型	方法和说明
CmsFile	I_CmsXmlContentHandler.prepareForWrite(CmsObject cms, CmsXmlContent content, CmsFile file) Prepares the given XML content to be written to the OpenCms VFS.
CmsFile	CmsDefaultXmlContentHandler.prepareForWrite(CmsObject cms, CmsXmlContent content, CmsFile file)
protected void	CmsDefaultXmlContentHandler.removeEmptyMappings(CmsObject cms, CmsFile file, CmsXmlContent content) Removes property values on resources for non-existing, optional elements.
protected void	CmsXmlContent.setFile(CmsFile file) Sets the file this XML content is written to.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, CmsFile file) Factory method to unmarshal (read) a XML content instance from a OpenCms VFS file that contains XML data.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding) Factory method to unmarshal (read) a XML content instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.
protected CmsFile	CmsDefaultXmlContentHandler.writeCategories(CmsObject cms, CmsFile file, CmsXmlContent content) Writes the categories if a category widget is present.

org.opencms.xml.page中CmsFile的使用

参数类型为CmsFile的org.opencms.xml.page中的方法

限定符和类型	方法和说明
protected void	CmsXmlPage.setFile(CmsFile file) Sets the file this XML page content is written to.
static CmsXmlPage	CmsXmlPageFactory.unmarshal(CmsObject cms, CmsFile file) Factory method to unmarshal (read) a XML page instance from a OpenCms VFS file that contains XML data.
static CmsXmlPage	CmsXmlPageFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding) Factory method to unmarshal (read) a XML page instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.