|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectucar.nc2.Group
public class Group
A Group is a logical collection of Variables. The Groups in a Dataset form a hierarchical tree, like directories on a disk. A Group has a name and optionally a set of Attributes. There is always at least one Group in a dataset, the root Group, whose name is the empty string.
Immutable if setImmutable() was called.
Constructor Summary | |
---|---|
Group(NetcdfFile ncfile,
Group parent,
java.lang.String shortName)
Constructor |
Method Summary | |
---|---|
void |
addAttribute(Attribute att)
Add new Attribute; replace old if has same name. |
void |
addDimension(Dimension d)
Add a shared Dimension |
void |
addEnumeration(EnumTypedef e)
Add an Enumeration |
void |
addGroup(Group g)
Add a nested Group |
void |
addVariable(Variable v)
Add a Variable |
Group |
commonParent(Group other)
Get the common parent of this and the other group. |
boolean |
equals(java.lang.Object oo)
Instances which have same name and parent are equal. |
Attribute |
findAttribute(java.lang.String name)
Find an Attribute in this Group by its name. |
Attribute |
findAttributeIgnoreCase(java.lang.String name)
Find an Attribute in this Group by its name, ignore case. |
Dimension |
findDimension(java.lang.String name)
Retrieve a Dimension using its (short) name. |
Dimension |
findDimensionLocal(java.lang.String name)
Retrieve a Dimension using its (short) name, in this group only |
EnumTypedef |
findEnumeration(java.lang.String name)
Find an Enumeration Typedef using its (short) name. |
Group |
findGroup(java.lang.String groupShortName)
Retrieve the Group with the specified (short) name. |
Variable |
findVariable(java.lang.String varShortName)
Find the Variable with the specified (short) name in this group. |
Variable |
findVariableOrInParent(java.lang.String varShortName)
Find the Variable with the specified (short) name in this group or a parent group. |
java.util.List<Attribute> |
getAttributes()
Get the set of attributes contained directly in this Group. |
java.util.List<Dimension> |
getDimensions()
Get the Dimensions contained directly in this group. |
java.util.List<EnumTypedef> |
getEnumTypedefs()
Get the enumerations contained directly in this group. |
java.util.List<Group> |
getGroups()
Get the Groups contained directly in this Group. |
java.lang.String |
getName()
Get the full name, starting from the root Group. |
java.lang.String |
getNameAndAttributes()
Get String with name and attributes. |
Group |
getParentGroup()
Get its parent Group, or null if its the root group. |
java.lang.String |
getShortName()
Get the "short" name, unique within its parent Group. |
java.util.List<Variable> |
getVariables()
Get the Variables contained directly in this group. |
int |
hashCode()
Override Object.hashCode() to implement equals. |
boolean |
isParent(Group other)
Is this a parent of the other Group? |
boolean |
isRoot()
Is this the root group? |
boolean |
remove(Attribute a)
Remove an Attribute : uses the attribute hashCode to find it. |
boolean |
remove(Dimension d)
Remove an Dimension : uses the dimension hashCode to find it. |
boolean |
remove(Group g)
Remove an Attribute : uses the Group hashCode to find it. |
boolean |
remove(Variable v)
Remove a Variable : uses the variable hashCode to find it. |
boolean |
removeDimension(java.lang.String dimName)
remove a Dimension using its name, in this group only |
boolean |
removeVariable(java.lang.String shortName)
remove a Variable using its (short) name, in this group only |
Group |
setImmutable()
Make this immutable. |
void |
setName(java.lang.String shortName)
Set the Group short name |
void |
setParentGroup(Group parent)
Set the Group's parent Group |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Group(NetcdfFile ncfile, Group parent, java.lang.String shortName)
ncfile
- NetcdfFile owns this Groupparent
- parent of Group. If null, this is the root Group.shortName
- short name of Group.Method Detail |
---|
public java.lang.String getName()
public boolean isRoot()
public java.lang.String getShortName()
public Group getParentGroup()
public java.util.List<Variable> getVariables()
public Variable findVariable(java.lang.String varShortName)
varShortName
- short name of Variable within this group.
public Variable findVariableOrInParent(java.lang.String varShortName)
varShortName
- short name of Variable.
public java.util.List<Group> getGroups()
public Group findGroup(java.lang.String groupShortName)
groupShortName
- short name of the nested group you are looking for. May be escaped.
NetcdfFile.unescapeName(java.lang.String)
public java.util.List<Dimension> getDimensions()
public java.util.List<EnumTypedef> getEnumTypedefs()
public Dimension findDimension(java.lang.String name)
name
- Dimension name.
public Dimension findDimensionLocal(java.lang.String name)
name
- Dimension name.
public java.util.List<Attribute> getAttributes()
public Attribute findAttribute(java.lang.String name)
name
- the name of the attribute. may be escaped
public Attribute findAttributeIgnoreCase(java.lang.String name)
name
- the name of the attribute
public EnumTypedef findEnumeration(java.lang.String name)
name
- Enumeration name.
public Group commonParent(Group other)
other
- the other group
public boolean isParent(Group other)
other
- another Group
public java.lang.String getNameAndAttributes()
public void setParentGroup(Group parent)
parent
- parent group.public void setName(java.lang.String shortName)
shortName
- short name.public void addAttribute(Attribute att)
att
- add this Attribute.public void addDimension(Dimension d)
d
- add this Dimensionpublic void addGroup(Group g)
g
- add this Group.public void addEnumeration(EnumTypedef e)
e
- add this Enumeration.public void addVariable(Variable v)
v
- add this Variable.public boolean remove(Attribute a)
a
- remove this Attribute.
public boolean remove(Dimension d)
d
- remove this Dimension.
public boolean remove(Group g)
g
- remove this Group.
public boolean remove(Variable v)
v
- remove this Variable.
public boolean removeDimension(java.lang.String dimName)
dimName
- Dimension name.
public boolean removeVariable(java.lang.String shortName)
shortName
- Variable name.
public Group setImmutable()
public java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object oo)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |