helma.org/Documentation/Type.properties Documentation

Version 35

Philipp — Wed, 13 Jan 2010 15:54:36 +0000

77	=== Property Naming ===
78	The property naming is case sensitive since Helma 1.7. This means that obj.foo, obj.Foo and obj.FOO no longer point to the same property. Properties starting with '_' are not persistable! If you define a property like '_lastAccess', Helma will not map it to a database column, even if you define a mapping.
79
86	Makes Initializes the property read only and initializes it with the value from the database and will not propagate updates on this property to the database. Please note that the property still can be modified by the application but all changes will be lost after restarting the application or reloading it's value from the database. If you need to prevent any modification on a property, you have to provide a setter function for it.

Version 34

Philipp — Tue, 27 Oct 2009 10:01:32 +0000

73	_children = collection(PrototypeToCollect)collection(SomeHopObject)

Version 33

Philipp — Tue, 27 Oct 2009 10:01:01 +0000

73	_children_children = collection(PrototypeToCollect)
75	It is used to define a HopObject itself as a collection. The keyword _children acts like a normal property, so you can use all of the collection specifications (.local, .foreign, .accessname, etc.) when defining the collection.

Version 32

Philipp — Tue, 27 Oct 2009 09:57:16 +0000

75	It is used to define a HopObject itself as a collection. The keyword _children acts like a normal property, so you can use all of the collection specifications when defining the collection. <tt>_children = collection(PrototypeToCollect)</tt>

Version 31

Philipp — Tue, 27 Oct 2009 09:54:45 +0000

75	It is used to define a HopObject itself as a collection. The keyword _children acts like a normal property, so you can use all of the collection specifications when defining the collection.
76

Version 30

Philipp — Tue, 27 Oct 2009 09:38:59 +0000

To store your HopObjects into a relational database system you need to define a database mapping. This is done in the type.properties files located in the persistent HopObject's prototype directory (e.g. apps/myApp/MyPrototype). The type.properties files contain no JDBC connection information, which is located in the db.properties file in the Helma installation directory or in the application directory.

Version 29

Philipp — Tue, 27 Oct 2009 09:35:28 +0000

Helma can store multiple Extended prototypes into one single database table. This feature could be useful if you extend prototypes for inheritance and if you want to store all sub-prototypes into are usually stored in the same relational database table. To enable this feature just add Thus, Helma needs a column way to tell which row in the table where Helma can store the prototype’s nameshould be instantiated with which object prototype. This column is referenced done using the _prototype entry, specifying a column in the type.properties table containing the name of the affected prototypeprototype for each row.

Version 28

Philipp — Fri, 23 Oct 2009 17:21:19 +0000

10	_table = tableNameTABLENAME
14	_prototype = prototypeColumnNamePROTOTYPE_COLUMN_NAME
39	The optional `_name` _name entry tells Helma which database column to use as object name. This is important for the user prototype, since it defines which column constitutes the user name. This field is only used by the session.login(name, pw)/app.registerUser(name, pw) functionality!

Version 27

Philipp — Fri, 23 Oct 2009 17:18:53 +0000

Set useMarkdown to

37	_name = NAME_COLUMN
38
39	The optional `_name` entry tells Helma which database column to use as object name. This is important for the user prototype, since it defines which column constitutes the user name.
40
41

Version 26

Philipp — Tue, 10 Mar 2009 14:35:37 +0000

61	If you define <tt>_parent = rootThe Photographer's types.warphotographers, agency, root.photographers</tt> Helma’s <tt>href()</tt> will look first in the war photographers collection and return an URL properties looks like <tt>/warphotographers/nachtwey</tt>, if the person is member of this. Now you call <tt>href()</tt> on the object Annie Leibovitz. She isn’t member of warphotographers, her agency property is null, but she is member of root.photographers, so <tt>href()</tt> will return <tt>/photographers/leibovitz</tt>.that:
62	<tt>_parent = root.warphotographers, agency, root.photographers
63	agency = object(Agency)
64	</tt>
65
66	Helma’s <tt>href()</tt> will look first in the war photographers collection and return an URL like <tt>/warphotographers/nachtwey</tt>, if the person is member of this. Now you call <tt>href()</tt> on the object Annie Leibovitz. She isn’t member of warphotographers, her agency property is null, but she is member of root.photographers, so <tt>href()</tt> will return <tt>/photographers/leibovitz</tt>.

Version 25

Philipp — Tue, 10 Mar 2009 14:04:31 +0000

57	The _parent entry solves a very specific problem: HopObjects do not know their canonical URLs if you call the href() function, since they can be members of more than one collection.
58
59	Example: James Nachtwey, Steve McCurry and Annie Leibovitz are well known photographers. A photographer might work for an agency, so the photographer’s prototype contains a property acency, but if they don’t, it’s null. Nachtwey and McCurry are war photographers, so a root.warphotographers collection cointains both. Leibovitz is neither taking pictures in war zones, nore working for an agency. All photographers are stored in the root’s photographers collection.
60
61	If you define <tt>_parent = root.warphotographers, agency, root.photographers</tt> Helma’s <tt>href()</tt> will look first in the war photographers collection and return an URL like <tt>/warphotographers/nachtwey</tt>, if the person is member of this. Now you call <tt>href()</tt> on the object Annie Leibovitz. She isn’t member of warphotographers, her agency property is null, but she is member of root.photographers, so <tt>href()</tt> will return <tt>/photographers/leibovitz</tt>.
62

Version 24

zumbrunn — Fri, 31 Oct 2008 12:15:01 +0000

If an entry in the _parent item does not contain a dot, it is interpreted as an object property of the current object that acts as the object's parent. If an entry contains a dot character, the part after the dot is interpreted as a collection in the parent object in which the current object is contained. Alternatively or additionally, a second or third dot separated part may indicate an object reference instead or in addition to a collection or mountpoint. If the _parent is specified as "root", it is not interpreted as a property of the current object. Instead, the application's root object is used as parent object.

Version 23

Philipp — Fri, 01 Aug 2008 16:12:42 +0000

34	Download this demo-application: <% this.attachment name="demo_animalfarm.zip" %>the animal demo application:
35	<% this.attachments %>

Version 22

Philipp — Fri, 01 Aug 2008 16:12:03 +0000

34	Download this demo-application: <% this.attachment name===="demo_animalfarm.zip" Demo Application ====%>
35	<% this.attachments %>

Version 21

Philipp — Fri, 01 Aug 2008 16:11:10 +0000

34	==== Demo Application ====
35	<% this.attachments %>
36

Version 20

Philipp — Fri, 01 Aug 2008 15:47:21 +0000

26	==== Inheritance ====
27
28	_extends = Prototype
29
30	The _extends entry engages Helma to inherit properties, functions and skins from another prototype. This can be compared to Java’s subclassing mechanism.
31
32	For example could be a Dog's _extends value the Animal, which inherits to the Dog prototype basic properties like father or mother, some skins and standard functions like getBiologicalClassification()
33
34
35	==== Inheritance ====
36
37	_extends = Prototype
38
39	The _extends entry engages Helma to inherit properties, functions and skins from another prototype. This can be compared to Java’s subclassing mechanism.
40
41	For example could be a Dog's _extends value the Animal, which inherits to the Dog prototype basic properties like father or mother, some skins and standard functions like getBiologicalClassification()

Version 19

Philipp — Fri, 01 Aug 2008 15:46:46 +0000

34	_extensionId = String or Integer
35
36	If you extend a prototype, Helma will use the name of the sub-prototype as value for the _prototype database column. This could slow down the performance. Better would be to choose a numeric value, which result faster index retrievals and queries. You can define this numeric value in the _extensionId property of the sub-prototype.
37
38	Example: If Helma needs all cats, the db-layer can filter all animals with the value '260486'. The value '260486' is defined in the cat’s type.properties as _extensionId! For dogs the _extensionId is set to a 'dogu dugu' string. Animals’ type.properties defines no _extensionId, so Helma uses the prototype’s name, which is 'Animal'!
39
40	<% this.image name="typeproperties_prototype_extensionid.png" %>
41

Version 18

Philipp — Wed, 11 Jun 2008 12:37:26 +0000

5	==== Database related ====
14	_extends = Prototype
15
16	The _extends entry engages Helma to inherit properties, functions and skins from another prototype. This can be compared to Java’s subclassing mechanism.
17
18	For example could be a Dog's _extends value the Animal, which inherits to the Dog prototype basic properties like father or mother, some skins and standard functions like getBiologicalClassification()
19
27	_parent ==== localPropertyName, localProperty.parentsCollectionName, root.collectionNameInheritance ====
29	The _parent entry contains a comma-separated list of properties of objects of this type to be used as parent. Objects must know their parent in order to generate correct URLs in their href() function._extends = If a property in the list is null, Helma will look on the following one to fetch a parent object.Prototype
31	If an The _extends entry in the _parent item does not contain a dotengages Helma to inherit properties, it is interpreted as an object property of the current object that acts as the object's parentfunctions and skins from another prototype. If an entry contains a dot character, the part after the dot is interpreted as a collection in the parent object in which the current object is contained. If the _parent is specified as "root", it is not interpreted as a property of the current object. Instead, the application's root object is used as parent objectThis can be compared to Java’s subclassing mechanism.
33	For example could be a Dog's _extends value the Animal, which inherits to the Dog prototype basic properties like father or mother, some skins and standard functions like getBiologicalClassification()
34
35	==== Object Management ====
36
37
38	_parent = localPropertyName, localProperty.parentsCollectionName, root.collectionName
39
40	The _parent entry contains a comma-separated list of properties of objects of this type to be used as parent. Objects must know their parent in order to generate correct URLs in their href() function. If a property in the list is null, Helma will look on the following one to fetch a parent object.
41
42	If an entry in the _parent item does not contain a dot, it is interpreted as an object property of the current object that acts as the object's parent. If an entry contains a dot character, the part after the dot is interpreted as a collection in the parent object in which the current object is contained. If the _parent is specified as "root", it is not interpreted as a property of the current object. Instead, the application's root object is used as parent object.

Version 17

Philipp — Fri, 06 Jun 2008 15:37:17 +0000

39	The _id entry defines the column to use as primary key. Helma requires a single primary key with no other functionality. You can read this unique ID from the _id-property of the HopObject.

Version 16

Philipp — Fri, 06 Jun 2008 15:17:17 +0000

29	Note: The Dog’s type.properties just defines the two new properties. All other stuff will be inherited from the Animal.
30

Version 15

Philipp — Fri, 06 Jun 2008 15:15:09 +0000

27	<% this.image name="typeproperties_prototype_helma.png" %>
28