# Class R.D.Document(CatalogAware, SimpleItem, IconShow.IconShow):

Part of Reportek.Document View In Hierarchy

An External Document allows indexing and conversions.

Split Table into Classes Show Methods in One Table

Line # | Kind | Name | Docs
--- | --- | --- | ---
189 | Method | __init__ | Initialize a new instance of Document
208 | Method | __str__ | Undocumented
210 | Method | __len__ | Undocumented
212 | Method | upload_time | Return the upload time
217 | Method | get_accept_time | Undocumented
224 | Method | set_accept_time | Undocumented
231 | Method | HEAD | Undocumented
244 | Method | __setstate__ | Undocumented
257 | Method | getMyOwner | Undocumented
264 | Method | logUpload | Log file upload and reupload in the envelope history
272 | Method | update_schema | Undocumented
280 | Method | index_html | Returns the contents of the file. Also, sets the
300 | Method | isGML | Checks whether or not this is a GML file
306 | Method | getQAScripts | Returns a list of QA script labels
312 | Method | _output_file | Write the necesary header information for
472 | Method | view_image_or_file | The default view of the contents of the File or Image.
476 | Method | link | return a HTML link tag to the file
487 | Method | icon_gif | return an icon for the file's MIME-Type
495 | Method | icon_html | The icon embedded in html with a link to the real file
499 | Method | is_broken | Check if external file exists and return true (1) or false (0)
508 | Method | get_size | Returns the size of the file or image
521 | Method | getFeedbacksForDocument | Returns the Feedback objects associated with this document
525 | Method | getExtendedFeedbackForDocument | Returns the feedback relevant for a document - URL and title
534 | Method | size | Returns a formatted stringified version of the file size
538 | Method | PrincipiaSearchSource | PrincipiaSearchSource is used by the ZCatalog, so we just
582 | Method | physicalpath | Generate the full filename, including directories from
610 | Method | manage_restrictDocument | Restrict access to this file
620 | Method | manage_unrestrictDocument | Remove access restriction for this file
636 | Method | manage_editDocument | Manage the edited values
654 | Method | _setFileSchema | If it is an XML file, then extract structure information
677 | Method | manage_file_upload | Upload file from local directory
710 | Method | PUT | Handle HTTP/FTP PUT requests
741 | Method | _get_content_type | Determine the mime-type
757 | Method | _writesegment | Write a segment of the file. The file is already open.
779 | Method | _copy | Read binary data from infile and write it to outfile
831 | Method | _bytetostring | Convert an int-value (file-size in bytes) to an String
851 | Method | _undo | restore filename after undo or copy-paste
860 | Method | _deletefile | Move the file to the undo file
868 | Method | _copyfile | Copy a file in the repository
876 | Method | _restorefile | Recover the file from undo
884 | Method | _get_ufn | If no unique filename has been generated, generate one
900 | Method | _get_new_ufn | Create a new unique filename
983 | Method | getXMLAttribute | Undocumented

Inherited from IconShow:

Line # | Kind | Name | Docs
--- | --- | --- | ---
59 | Method | getContentType | Get the content type of a file or image.
65 | Method | getIconPath | Depending on the MIME Type of the file/image an icon
82 | Method | _getMIMECatAndSub | Split MIME String into Category and Subcategory

Line # | Kind | Name | Docs
--- | --- | --- | ---
189 | Method | __init__ | Initialize a new instance of Document
210 | Method | __len__ | Undocumented
244 | Method | __setstate__ | Undocumented
208 | Method | __str__ | Undocumented
831 | Method | _bytetostring | Convert an int-value (file-size in bytes) to an String
779 | Method | _copy | Read binary data from infile and write it to outfile
868 | Method | _copyfile | Copy a file in the repository
860 | Method | _deletefile | Move the file to the undo file
741 | Method | _get_content_type | Determine the mime-type
900 | Method | _get_new_ufn | Create a new unique filename
884 | Method | _get_ufn | If no unique filename has been generated, generate one
82 | Method | _getMIMECatAndSub | Split MIME String into Category and Subcategory
312 | Method | _output_file | Write the necesary header information for
876 | Method | _restorefile | Recover the file from undo
654 | Method | _setFileSchema | If it is an XML file, then extract structure information
851 | Method | _undo | restore filename after undo or copy-paste
757 | Method | _writesegment | Write a segment of the file. The file is already open.
217 | Method | get_accept_time | Undocumented
508 | Method | get_size | Returns the size of the file or image
59 | Method | getContentType | Get the content type of a file or image.
525 | Method | getExtendedFeedbackForDocument | Returns the feedback relevant for a document - URL and title
521 | Method | getFeedbacksForDocument | Returns the Feedback objects associated with this document
65 | Method | getIconPath | Depending on the MIME Type of the file/image an icon
257 | Method | getMyOwner | Undocumented
306 | Method | getQAScripts | Returns a list of QA script labels
983 | Method | getXMLAttribute | Undocumented
231 | Method | HEAD | Undocumented
487 | Method | icon_gif | return an icon for the file's MIME-Type
495 | Method | icon_html | The icon embedded in html with a link to the real file
280 | Method | index_html | Returns the contents of the file. Also, sets the
499 | Method | is_broken | Check if external file exists and return true (1) or false (0)
300 | Method | isGML | Checks whether or not this is a GML file
476 | Method | link | return a HTML link tag to the file
264 | Method | logUpload | Log file upload and reupload in the envelope history
636 | Method | manage_editDocument | Manage the edited values
677 | Method | manage_file_upload | Upload file from local directory
610 | Method | manage_restrictDocument | Restrict access to this file
620 | Method | manage_unrestrictDocument | Remove access restriction for this file
582 | Method | physicalpath | Generate the full filename, including directories from
538 | Method | PrincipiaSearchSource | PrincipiaSearchSource is used by the ZCatalog, so we just
710 | Method | PUT | Handle HTTP/FTP PUT requests
224 | Method | set_accept_time | Undocumented
534 | Method | size | Returns a formatted stringified version of the file size
272 | Method | update_schema | Undocumented
212 | Method | upload_time | Return the upload time
472 | Method | view_image_or_file | The default view of the contents of the File or Image.

def __init__(self, id, title='', content_type='', parent_path=None):
Initialize a new instance of Document If a document is created through FTP, self.absolute_url doesn't work.

def __str__(self):
Undocumented
def __len__(self):
Undocumented
def upload_time(self):
Return the upload time

def get_accept_time(self):
Undocumented
def set_accept_time(self, totime=1):
Undocumented
def HEAD(self, REQUEST, RESPONSE):
Undocumented
def __setstate__(self, state):
Undocumented
def getMyOwner(self):
Undocumented
def logUpload(self):
Log file upload and reupload in the envelope history The workitems' event logs are used since these are displayed on the envelope's history tab

def update_schema(self):
Undocumented
def index_html(self, REQUEST, RESPONSE, icon=0):
Returns the contents of the file. Also, sets the Content-Type HTTP header to the objects content type.

def isGML(self):
Checks whether or not this is a GML file

def getQAScripts(self):
Returns a list of QA script labels which can be manually run against the contained XML files

def _output_file(self, REQUEST, RESPONSE, filename, content_type):
Write the necesary header information for (possibly) chunked output

def view_image_or_file(self):
The default view of the contents of the File or Image.

def link(self, text='', **args):
return a HTML link tag to the file

def icon_gif(self, REQUEST, RESPONSE):
return an icon for the file's MIME-Type

def icon_html(self):
The icon embedded in html with a link to the real file

def is_broken(self):
Check if external file exists and return true (1) or false (0)

def get_size(self):
Returns the size of the file or image

def getFeedbacksForDocument(self):
Returns the Feedback objects associated with this document

def getExtendedFeedbackForDocument(self):
Returns the feedback relevant for a document - URL and title

def size(self):
Returns a formatted stringified version of the file size

def PrincipiaSearchSource(self):
PrincipiaSearchSource is used by the ZCatalog, so we just convert data to raw text (don't bother formatting) Since ZCatalog can reindex everything, it will take time to run all those conversions, therefore we cache it.

def physicalpath(self, filename=None):
Generate the full filename, including directories from self._repository and self.filename

def manage_restrictDocument(self, REQUEST=None):
Restrict access to this file

def manage_unrestrictDocument(self, REQUEST=None):
Remove access restriction for this file

def manage_editDocument(self, title='', content_type='', xml_schema_location='', applyRestriction='', restricted='', REQUEST=None):
Manage the edited values

def _setFileSchema(self, p_content):
If it is an XML file, then extract structure information

def manage_file_upload(self, file='', content_type='', REQUEST=None):
Upload file from local directory

def PUT(self, REQUEST, RESPONSE):
Handle HTTP/FTP PUT requests

def _get_content_type(self, file, body, id, content_type=None):
Determine the mime-type

def _writesegment(self, instream, outstream, start, length):
Write a segment of the file. The file is already open.

def _copy(self, infile, outfile, maxblocks=16384, isString=0):
Read binary data from infile and write it to outfile infile and outfile may be strings, in which case a file with that name is opened, or filehandles, in which case they are accessed directly. A block is 131072 bytes. maxblocks prevents it from >2GB !New! The isString parameter is not 0, the file is not a handler, but string. However, it is not the name of another object to copy, but the content of the file itself.

def _bytetostring(self, value):
Convert an int-value (file-size in bytes) to an String with the file-size in Byte, KB or MB

def _undo(self):
restore filename after undo or copy-paste

def _deletefile(self, filename):
Move the file to the undo file

def _copyfile(self, old_fn, new_fn):
Copy a file in the repository This actually involves copying two files

def _restorefile(self, filename):
Recover the file from undo

def _get_ufn(self, filename):
If no unique filename has been generated, generate one otherwise, return the existing one.

def _get_new_ufn(self):
Create a new unique filename

def getXMLAttribute(self, p_element):
Undocumented