org.openl.rules.diff.hierarchy

Interface Projection

All Known Implementing Classes:

AbstractProjection, XlsProjection

public interface Projection

Projection of an artifact.

The Projection can be considered as one of many Views of any object.

A Projection shows some properties of actual artifact and can hides others, that are not relevant to domain of the Projection.

Also Projection can have own hierarchy of sub elements which can be completely different from hierarchy of physical artifact.

Child of the Projection is Projection that allows multiple views on each element depending on its position in hierarchy. But that can lead to extreme memory allocation also. This feature should be used with care.

Author:

Aleh Bykhavets

Method Summary

Modifier and Type	Method and Description
List<Projection>	getChildren() Direct children of the projection.
String	getName() Logical name of data.
Collection<ProjectionProperty>	getProperties() Projection specific properties of the artifact.
ProjectionProperty	getProperty(String propertyName) Get property of the artifact by name.
Object	getPropertyValue(String propertyName) Get raw value of property.
String	getType()

Method Detail

getName

String getName()

Logical name of data.

Different projections can have different names and the name of a projection can differ from name of an artifact.

The logical name of a projection should reflect its meaning in specific domain.

Returns:

logical name

getType

String getType()

getProperties

Collection<ProjectionProperty> getProperties()

Projection specific properties of the artifact.

An artifact can have a lot of properties and not all of them can exist in the projection. It is possible that a projection will have no properties even if the artifact has some.

If there is no properties empty (zero length) array is returned.

Returns:

projection specific properties

getProperty

ProjectionProperty getProperty(String propertyName)

Get property of the artifact by name.

Parameters:

propertyName - name of property to be found

Returns:

property or null

getPropertyValue

Object getPropertyValue(String propertyName)

Get raw value of property. If there is no such property returns null.

Note that null can mean that such property exists but its value is null.

Parameters:

propertyName - name of property

Returns:

raw value of property or null

getChildren

List<Projection> getChildren()

Direct children of the projection.

If there is no children empty (zero length) array is returned.

Returns:

direct children or empty array