JeeWiz Architect's Guide - BaseViewRelation Object


	The Model-Driven System Builder

JeeWiz Architect's Guide

Contents > 14. 'Business Object' Reference

14.10 BaseViewRelation Object

Used on

jarBase

Subclassed By

dataViewRelation

stoRelation

Description Specifies the participation of a view in a view relationship. This is very similar to the relation (for entities). However this relationship is between two base-view objects.

This is a base classe for the specialisations - data-view-relation, sto-relation and ui-view-relation.

Contained
Lists

1

Name   baseViewEnd

Type   baseViewEnd

Description   Specifies the two views that participate in the relationship.

GenerateAllList   true

Validation 1.   A view relation requires exactly 2 elements
2.   The 'access' for a view end must be 'public'
3.   The two ends in a relation must have the same stereotype name
4.   The two ends in a relation must be of the same class

Inherited
properties

template (base property)

text (base property)

jwpattern (base property)

14.10.1	Property 'name'
14.10.2	Property 'sqlStatement'
14.10.3	Property 'additionalWhereClause'
14.10.4	Property 'access'
14.10.5	Property 'package'
14.10.6	Property 'readable'
14.10.7	Property 'writeable'
14.10.8	Property 'uid'
14.10.9	Property 'description'

14.10.1 Property 'name'

Type

String

14.10.2 Property 'sqlStatement'

*Description*	(TBD: change name to 'where-clause'). Specifies the extra piece on the where clause to query the data for the non-master end.
*Type*	String
*Default*

14.10.3 Property 'additionalWhereClause'

*Description*	Specifies the extra piece on the where clause to query the data for the non-master end. This is added to the end of the generated where-clause and
*Type*	String

14.10.4 Property 'access'

*Description*	In the business model, business object/methods and attributes are by definition public - they are designed for access by clients outside the object. Therefore the 'access' value is fixed at 'public'. This factor hides the 'access' property from users. However, the attribute can be set programmatically (i.e. in some patterns access is set to private) so that it will be rendered via normal field generators according to the architect's design.
*Type*	String
*Default*	public
*Hidden*	true

14.10.5 Property 'package'

*Alias*	namespace
*Description*	This is the package attribute: it declares the name of the package that this interface (or class, or entity, etc.) belongs to. It can be used on reference types (interfaces and classes) and all their derivatives associations assemblies of model-objects containers of same, like jars. It uses delegation of responsibility to search its parent chain. For example, in the J2EE realm, this means that the package can be specified on (working up the containment chain): an entity, or its ejb-jar, or the application, or in the assembly or in the build properties '.jwp' file. If none of these is specified the package will be null. Null packages are not recommended but legal for simple Java builds. For larger systems, null packages are not allowed. The combination of the package and class name (i.e. the fully-qualified Java classname) must be unique across all reference types and their derivatives in a build.
*Type*	String
*Delegates*	true

14.10.6 Property 'readable'

*Description*	Defines whether a public 'getter' method will be generated to get the value.
*Type*	boolean
*Default*	true

14.10.7 Property 'writeable'

*Description*	Defines whether a public 'setter' method will be generated to set the attribute.
*Type*	boolean
*Default*	true

14.10.8 Property 'uid'

*Description*	The 'uid' is a Unique IDentifier for a methods in the business object model (and derivatives like J2EE). The 'uid' uniquely identifies the method, even if the name or signature of the method changes. This will normally be generated by the modelling tool; if not, it can be entered manually (but make sure it is unique!).
*Type*	String

14.10.9 Property 'description'

*Description*	Optional description. Use this to document the meaning of a particular item specify functionality at the design stage for implementation later.
*Type*	String
*Support Element Inputs*	true