Versions Compared

Old Version 2

changes.mady.by.user Shaun Forbes

Saved on

compared with

New Version Current

changes.mady.by.user Shaun Forbes

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
xml
xml
titleExample, all be it incomplete, showing some client configurations
linenumberstrue
<?xml version="1.0" encoding="UTF-8"?>

<config xmlns="urn:com.cohga.server.config#1.0" xmlns:client="urn:com.cohga.html.client#1.0">

	<client:config id="test1">
		<view id="com.cohga.html.client.map.mapView">
			<extents>
				<initial minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
				<full minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
			</extents>
		</view>
	</client:config>

	<client:config id="test2">
		<view id="com.cohga.html.client.map.mapView">
			<extents>
				<initial minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
				<full minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
			</extents>
		</view>
	</client:config>

	<client:config id="test3">
		<view id="com.cohga.html.client.map.mapView">
			<extents>
				<initial minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
				<full minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
			</extents>
		</view>
	</client:config>

</config>

To create a new snippet for the extents in the above sample we would extract the part of the configuration we want to make common, like this:

Code Block
xml
xml
titleCommon extents extracted into a snippet with the id 'defaults'
linenumberstrue
...
	<client:extents id="defaults">
		<initial minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
		<full minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
	</client:extents>
...

This would create a new snippet, called defaults of type extents. The id, defaults in the above example, isn't important and we can use anything that makes sense here (it's just used to refer to a specific snippet later when we want to use it). The type, extents in the above example, is important however and must be the same as the target tag that we're actually creating the snippet for, and it's the combination of the id and type that's used later on to include the snippet within a client configuration.

...

Code Block
xml
xml
titleReferencing the new snippet
linenumberstrue

<extents ref="defaults"/>

...

Code Block
xml
xml
2Example configurations altered to use a snippet
linenumberstrue

<?xml version="1.0" encoding="UTF-8"?>

<config xmlns="urn:com.cohga.server.config#1.0" xmlns:client="urn:com.cohga.html.client#1.0">

	<client:extents id="defaults">
		<initial minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
		<full minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
	</client:extents>

	<client:config id="test1">
		<view id="com.cohga.html.client.map.mapView">
			<extents ref="defaults"/>
		</view>
	</client:config>

	<client:config id="test2">
		<view id="com.cohga.html.client.map.mapView">
			<extents ref="defaults"/>
		</view>
	</client:config>

	<client:config id="test3">
		<view id="com.cohga.html.client.map.mapView">
			<extents ref="defaults"/>
		</view>
	</client:config>

</config>

Refining snippets

...

Code Block
xml
xml
titleAltering included snippets
linenumberstrue

<?xml version="1.0" encoding="UTF-8"?>

<config xmlns="urn:com.cohga.server.config#1.0" xmlns:client="urn:com.cohga.html.client#1.0">

	<client:extents id="defaults">
		<initial minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
		<full minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
	</client:extents>

	<client:config id="test1">
		<view id="com.cohga.html.client.map.mapView">
			<extents ref="defaults"/>
		</view>
	</client:config>

	<client:config id="test2">
		<view id="com.cohga.html.client.map.mapView">
			<extents ref="defaults">
				<initial minx="327000" miny="5811000" maxx="330000" maxy="5813000"/>
			</extents>
		</view>
	</client:config>

	<client:config id="test3">
		<view id="com.cohga.html.client.map.mapView">
			<extents ref="defaults">
				<limit minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
			</extents>
		</view>
	</client:config>

</config>

this would be the equivalent of

Code Block
xml
xml
titleAltered example shown not using snippets
linenumberstrue

<?xml version="1.0" encoding="UTF-8"?>

<config xmlns="urn:com.cohga.server.config#1.0" xmlns:client="urn:com.cohga.html.client#1.0">

	<client:config id="test1">
		<view id="com.cohga.html.client.map.mapView">
			<extents>
				<initial minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
				<full minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
			</extents>
		</view>
	</client:config>

	<client:config id="test2">
		<view id="com.cohga.html.client.map.mapView">
			<extents>
				<initial minx="327000" miny="5811000" maxx="330000" maxy="5813000"/>
				<full minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
			</extents>
		</view>
	</client:config>

	<client:config id="test3">
		<view id="com.cohga.html.client.map.mapView">
			<extents>
				<initial minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
				<full minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
				<limit minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
			</extents>
		</view>
	</client:config>

</config>


Note

One thing you can't currently do is to remove a sub-tag from a snippet via the reference.

...

Code Block
xml
xml
linenumberstrue
...
	<client:initial id="default" minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>

	<client:full id="default" minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>

	<client:limit id="default" minx="320000" miny="5810000" maxx="360000" maxy="5840000"/>

	<client:extents id="defaults">
		<initial ref="default"/>
		<full ref="default"/>
		<limit ref="default"/>
	</client:extents>
...

And if we wanted to we could create a separate snippet for a "custom" extent

Code Block
xml
xml
linenumberstrue
...
	<client:initial id="custom" minx="328000" miny="5811000" maxx="331000" maxy="5817000"/>
...

Then in our "custom" client configuration we could use the following to accomplish the same as we did previously

Code Block
xml
xml
linenumberstrue
...
	<client:config id="custom">
		<view id="com.cohga.html.client.map.mapView">
			<extents ref="defaults">
				<initial ref="custom"/>
			</extents>
		</view>
	</client:config>
...

Replacing content with an id attributes

...

Code Block
xml
xml
titleExample with two client configurations
linenumberstrue

<?xml version="1.0" encoding="UTF-8"?>

<config xmlns="urn:com.cohga.server.config#1.0" xmlns:client="urn:com.cohga.html.client#1.0">

	<client:config id="test1">
		<view id="com.cohga.html.client.map.mapView">
			<extents>
				<initial minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
				<full minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
			</extents>
		</view>
	</client:config>

	<client:config id="test2">
		<view id="com.cohga.html.client.map.mapView">
			<extents>
				<initial minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
				<full minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
			</extents>
		</view>
	</client:config>

</config>

we might come up with the following, which would not work.

Code Block
xml
xml
titleExtracting map view into a snippet the wrong way
linenumberstrue

<?xml version="1.0" encoding="UTF-8"?>

<config -8"?>

<config xmlns="urn:com.cohga.server.config#1.0" xmlns:client="urn:com.cohga.html.client#1.0">

	<client:view id="com.cohga.html.client.map.mapView">
		<extents>
			<initial minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
			<full minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
		</extents>
	</client:view>

	<client:config id="test1">
		<view ref="com.cohga.html.client.map.mapView"/>
	</client:config>

	<client:config id="test2">
		<view ref="com.cohga.html.client.map.mapView"/>
	</client:config>

</config>


Info

The reason the above code does not work is that the code that processes the snippets does not know that the id for the view tag is important, and just treats it an an identifier used to provide the link between the snippet and the reference to include it.
But as part of the including process it's the content of the snippet, which does not include the id, that replaces the reference, thereby loosing the id as part of the include process.

...

Code Block
xml
xml
titleExample with two client configurations
linenumberstrue

<?xml version="1.0" encoding="UTF-8"?>

<config xmlns="urn:com.cohga.server.config#1.0" xmlns:client="urn:com.cohga.html.client#1.0">

	<client:config id="test1">
		<view>
			<extents>
				<initial minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
				<full minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
			</extents>
		</view>
	</client:config>

	<client:config id="test2">
		<view>
			<extents>
				<initial minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
				<full minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
			</extents>
		</view>
	</client:config>

</config>

The way to fix this problem is to include the id in the reference, as follows:

Code Block
xml
xml
titleExample with two client configurations
linenumberstrue

<?xml version="1.0" encoding="UTF-8"?>

<config xmlns="urn:com.cohga.server.config#1.0" xmlns:client="urn:com.cohga.html.client#1.0">

	<client:view id="map">
		<extents>
			<initial minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
			<full minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
		</extents>
	</client:view>

	<client:config id="test1">
		<view ref="map" id="com.cohga.html.client.map.mapView"/>
	</client:config>

	<client:config id="test2">
		<view ref="map" id="com.cohga.html.client.map.mapView"/>
	</client:config>

</config>

Possible alternative format

...

Code Block
xml
xml
titlePossible future syntax for snippets
linenumberstrue

<?xml version="1.0" encoding="UTF-8"?>

<config xmlns="urn:com.cohga.server.config#1.0" xmlns:client="urn:com.cohga.html.client#1.0">

	<client:snippet id="map">
		<view id="com.cohga.html.client.map.mapView">
			<extents>
				<initial minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
				<full minx="327098" miny="5811358" maxx="351971" maxy="5827675"/>
			</extents>
		</view>
	</client:snippet>

	<client:config id="test1">
		<view ref="map"/>
	</client:config>

	<client:config id="test2">
		<view ref="map"/>
	</client:config>

</config>

This has the added bonus that the snippet can contain more than one item, although if that's actually useful is as yet unclear.