Difference between revisions of "TruxtonFileType"
(→id) |
|||
| Line 1: | Line 1: | ||
| − | This class lets you add to the <code>FileType</code> table in Truxton. | + | This class lets you add to the <code>[FileType]</code> table in Truxton. |
This is how you add your own file types to Truxton. | This is how you add your own file types to Truxton. | ||
=Attributes and Methods= | =Attributes and Methods= | ||
| − | |||
==<code>extension</code>== | ==<code>extension</code>== | ||
The most common [https://en.wikipedia.org/wiki/Filename_extension file name extension] associated with this file type. | The most common [https://en.wikipedia.org/wiki/Filename_extension file name extension] associated with this file type. | ||
Setting this value is optional. | Setting this value is optional. | ||
| − | This corresponds to the <code>Extension</code> column of the <code>FileType</code> table. | + | This corresponds to the <code>[Extension]</code> column of the <code>[FileType]</code> table. |
==<code>id</code>== | ==<code>id</code>== | ||
| Line 13: | Line 12: | ||
Setting this value is optional. | Setting this value is optional. | ||
If you don't, one will be randomly chosen for you during the <code>save()</code> call. | If you don't, one will be randomly chosen for you during the <code>save()</code> call. | ||
| − | This corresponds to the <code>ID</code> column of the <code>FileType</code> table. | + | This corresponds to the <code>[ID]</code> column of the <code>[FileType]</code> table. |
The valid range of values is 11,000 through 32,767. | The valid range of values is 11,000 through 32,767. | ||
==<code>longname</code>== | ==<code>longname</code>== | ||
A description of the file type. | A description of the file type. | ||
| − | This corresponds to the <code>LongName</code> column of the <code>FileType</code> table. | + | This corresponds to the <code>[LongName]</code> column of the <code>[FileType]</code> table. |
Setting this field is optional, if it is not set, the value of <code>shortname</code> will be used. | Setting this field is optional, if it is not set, the value of <code>shortname</code> will be used. | ||
==<code>mimetype</code>== | ==<code>mimetype</code>== | ||
The [https://en.wikipedia.org/wiki/Media_type MIME type] most commonly associated with the file type. | The [https://en.wikipedia.org/wiki/Media_type MIME type] most commonly associated with the file type. | ||
| − | This corresponds to the <code>MIME</code> column of the <code>FileType</code> table. | + | This corresponds to the <code>[MIME]</code> column of the <code>[FileType]</code> table. |
Setting this field is optional, the default is <code>application/octet-stream</code> | Setting this field is optional, the default is <code>application/octet-stream</code> | ||
| Line 29: | Line 28: | ||
An 16-bit integer value for the more generic type of this file type. | An 16-bit integer value for the more generic type of this file type. | ||
Setting this value is optional. | Setting this value is optional. | ||
| − | This corresponds to the <code>ParentFileTypeID</code> column of the <code>FileType</code> table. | + | This corresponds to the <code>[ParentFileTypeID]</code> column of the <code>[FileType]</code> table. |
| − | If you do set this value, it should appear | + | If you do set this value, it should appear in the <code>[ID]</code> column of the <code>[FileType]</code> table. |
==<code>shortname</code>== | ==<code>shortname</code>== | ||
A short name for the file type. | A short name for the file type. | ||
| − | This corresponds to the <code>ShortName</code> column of the <code>FileType</code> table. | + | This corresponds to the <code>[ShortName]</code> column of the <code>[FileType]</code> table. |
Setting this value is mandatory. | Setting this value is mandatory. | ||
==<code>save()</code>== | ==<code>save()</code>== | ||
| − | This will commit the information to the <code>FileType</code> table. | + | This will commit the information to the <code>[FileType]</code> table. |
It will return [https://docs.python.org/3/library/constants.html#True True] if the record was saved to the database, [https://docs.python.org/3/library/constants.html#False False] if there was an error. | It will return [https://docs.python.org/3/library/constants.html#True True] if the record was saved to the database, [https://docs.python.org/3/library/constants.html#False False] if there was an error. | ||
=Sample= | =Sample= | ||
| − | + | <source lang="Python" highlight="6,8-12,14"> | |
| − | < | ||
import truxton | import truxton | ||
| Line 63: | Line 61: | ||
if __name__ == "__main__": | if __name__ == "__main__": | ||
main() | main() | ||
| − | </ | + | </source> |
Revision as of 17:10, 30 November 2020
This class lets you add to the [FileType] table in Truxton.
This is how you add your own file types to Truxton.
Contents
Attributes and Methods
extension
The most common file name extension associated with this file type.
Setting this value is optional.
This corresponds to the [Extension] column of the [FileType] table.
id
An 16-bit integer value for the file type.
Setting this value is optional.
If you don't, one will be randomly chosen for you during the save() call.
This corresponds to the [ID] column of the [FileType] table.
The valid range of values is 11,000 through 32,767.
longname
A description of the file type.
This corresponds to the [LongName] column of the [FileType] table.
Setting this field is optional, if it is not set, the value of shortname will be used.
mimetype
The MIME type most commonly associated with the file type.
This corresponds to the [MIME] column of the [FileType] table.
Setting this field is optional, the default is application/octet-stream
parentid
An 16-bit integer value for the more generic type of this file type.
Setting this value is optional.
This corresponds to the [ParentFileTypeID] column of the [FileType] table.
If you do set this value, it should appear in the [ID] column of the [FileType] table.
shortname
A short name for the file type.
This corresponds to the [ShortName] column of the [FileType] table.
Setting this value is mandatory.
save()
This will commit the information to the [FileType] table.
It will return True if the record was saved to the database, False if there was an error.
Sample
import truxton
def main():
t = truxton.create()
file_type = t.newfiletype()
file_type.parentid = truxton.Type_XML
file_type.shortname = "MyType"
file_type.longname = "A custom file type derived from XML for demo purposes"
file_type.extension = "xm2"
file_type.mimetype = "text/xml"
file_type.save()
print( "ID is " + str(file_type.id))
if __name__ == "__main__":
main()
