com.simplifiedlogic.nitro.jlink.data

Class SimpRepData

java.lang.Object

com.simplifiedlogic.nitro.jlink.data.SimpRepData

public class SimpRepData
extends java.lang.Object

Simplified Representation data for a model

A simplified rep is a list of component paths. The tricky part is whether those components are included or excluded from the rep.

If defaultExclude=true, then any components not listed are excluded from the rep, and the listed items are included.

If defaultExclude=false (the default), then any components not listed are included in the rep, and the listed items are excluded.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_EXCLUDE
static int	DEFAULT_INCLUDE
static int	DEFAULT_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
SimpRepData()

Method Summary

Methods

Modifier and Type	Method and Description
void	addItem(java.util.List<java.lang.Integer> path) Add a new component to the representation
void	addSubItem(java.util.List<java.lang.Integer> path, SimpRepData data) Add a new sub-rep to the representation
boolean	containsDescendant(java.util.List<java.lang.Integer> path) Check whether the representation contains a reference to a descendant of the specified component.
boolean	containsItem(java.util.List<java.lang.Integer> path) Check whether the representation contains a reference to a component.
SimpRepData	containsNestedRep(java.util.List<java.lang.Integer> path) Check whether the representation contains a nested rep for a specified assembly component path.
boolean	excludes(java.util.List<java.lang.Integer> path) Check whether a component is excluded from the representation.
boolean	excludesDescendant(java.util.List<java.lang.Integer> path) Check whether any descendant of a component is excluded from the representation.
java.util.List<java.util.List<java.lang.Integer>>	getItems()
int	getLevelDefault(java.util.List<java.lang.Integer> path) Returns the default status (include or exclude) for the givem subassembly path
java.lang.String	getName()
java.util.List<java.lang.Integer>	getPath()
SimpRepData	getSimpRep(java.util.List<java.lang.Integer> path) Finds the simplified rep specific to the given subassembly.
java.util.List<SimpRepData>	getSubItems()
boolean	hasItem(java.util.List<java.lang.Integer> path) Checks whether the specified component exists as an item anywhere in the simplified rep tree
boolean	isDefaultExclude()
int	numPaths() Returns the number of items (component paths) in the simplified rep.
void	setDefaultExclude(boolean defaultExclude)
void	setItems(java.util.List<java.util.List<java.lang.Integer>> items)
void	setName(java.lang.String name)
void	setPath(java.util.List<java.lang.Integer> path)
void	setSubItems(java.util.List<SimpRepData> subItems)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_UNKNOWN

public static final int DEFAULT_UNKNOWN

See Also:

Constant Field Values

DEFAULT_EXCLUDE

public static final int DEFAULT_EXCLUDE

See Also:

Constant Field Values

DEFAULT_INCLUDE

public static final int DEFAULT_INCLUDE

See Also:

Constant Field Values

Constructor Detail

SimpRepData

public SimpRepData()

Method Detail

addItem

public void addItem(java.util.List<java.lang.Integer> path)

Add a new component to the representation

Parameters:

path - The component path for the component

addSubItem

public void addSubItem(java.util.List<java.lang.Integer> path,
              SimpRepData data)

Add a new sub-rep to the representation

Parameters:

path - The data for sub-representation

data - The JShell object representing the data

excludes

public boolean excludes(java.util.List<java.lang.Integer> path)

Check whether a component is excluded from the representation.

Parameters:

path - The component path to check

Returns:

Whether the component is excluded from the representation

excludesDescendant

public boolean excludesDescendant(java.util.List<java.lang.Integer> path)

Check whether any descendant of a component is excluded from the representation.

If the input path is empty, then it will check whether the representation excludes anything. The PROBLEM with this is that it only works right when the rep is defaultExclude=false. When defaultExclude=true BUT all the components in the rep are items (included) then it will return true when it should return false.

Parameters:

path - The component path to check

Returns:

Whether the component is excluded from the representation

containsItem

public boolean containsItem(java.util.List<java.lang.Integer> path)

Check whether the representation contains a reference to a component. Note that this does NOT indicate that the component is excluded or excluded, you will need to check the defaultExclude flag or call excludes() for that.

Parameters:

path - The component path for the component

Returns:

Whether the rep contains the component

containsNestedRep

public SimpRepData containsNestedRep(java.util.List<java.lang.Integer> path)

Check whether the representation contains a nested rep for a specified assembly component path.

Parameters:

path - The component path for the subassembly

Returns:

The nested rep for the subassembly

getLevelDefault

public int getLevelDefault(java.util.List<java.lang.Integer> path)

Returns the default status (include or exclude) for the givem subassembly path

Parameters:

path - The component path for the subassembly

Returns:

One of DEFAULT_INCLUDE, DEFAULT_EXCLUDE, or DEFAULT_UNKNOWN

hasItem

public boolean hasItem(java.util.List<java.lang.Integer> path)

Checks whether the specified component exists as an item anywhere in the simplified rep tree

Parameters:

path - The component path for the component

Returns:

Whether the item was found

getSimpRep

public SimpRepData getSimpRep(java.util.List<java.lang.Integer> path)

Finds the simplified rep specific to the given subassembly.

Parameters:

path - The component path for the subassembly

Returns:

The simplified rep for that subassembly, or null if there is none

containsDescendant

public boolean containsDescendant(java.util.List<java.lang.Integer> path)

Check whether the representation contains a reference to a descendant of the specified component. A descendant may not be an immediate child. Note that this does NOT indicate that the component is excluded or excluded, you will need to check the defaultExclude flag or call excludes() for that.

Parameters:

path - The component path for the component

Returns:

Whether the rep contains any descendant the component

numPaths

public int numPaths()

Returns the number of items (component paths) in the simplified rep.

Returns:

The number of items (component paths) in the simplified rep

getName

public java.lang.String getName()

Returns:

Name of the simplified rep

setName

public void setName(java.lang.String name)

Parameters:

name - Name of the simplified rep

getItems

public java.util.List<java.util.List<java.lang.Integer>> getItems()

Returns:

List of component paths in the rep

setItems

public void setItems(java.util.List<java.util.List<java.lang.Integer>> items)

Parameters:

items - List of component paths in the rep

isDefaultExclude

public boolean isDefaultExclude()

Returns:

Whether non-listed componets are excluded; if false, then non-listed components are included

setDefaultExclude

public void setDefaultExclude(boolean defaultExclude)

Parameters:

defaultExclude - Whether non-listed componets are excluded; if false, then non-listed components are included

getPath

public java.util.List<java.lang.Integer> getPath()

setPath

public void setPath(java.util.List<java.lang.Integer> path)

getSubItems

public java.util.List<SimpRepData> getSubItems()

setSubItems

public void setSubItems(java.util.List<SimpRepData> subItems)