Document Relations

[timrobertson100]

Can you please document the expected behaviour of relations which is referenced in many places, e.g. here?

I had naively assumed a DP reader would follow foreign keys and return the end of the relation in a nested object inline.

Thanks!

[iSnow]

That should be detailed in https://github.com/frictionlessdata/specs which is what we are trying to implement. If that project doesn't have it, the issue should be reported there first

[iSnow]

Closing as this is a documentation issue for the specifications, not the Java port.

[timrobertson100]

FWIW I think this is a poor response. This is a Java API with public methods that have next to no documentation - linking to the relevant section of the official documentation would be appropriate.

The jdoc at the top says it is based on "http://frictionlessdata.io/specs/data-resource/" but nothing in that helps someone know what the fields in this mean

List<Object[]> getData(boolean cast, boolean keyed, boolean extended, boolean relations) throws Exception;

The class has useless jdoc for getters and setters, but omits jdoc for the bits that are meaningful and not obviously described anywhere.

[iSnow]

Sorry to hear that but it is what it is.

I am keenly aware the documentation sucks, the code has issues and the cohesion between code and specs is lacking. The Java port for ages has had basically no contributors except for me and I am an unpaid volunteer who took this over. I tried to improve the quality of code and docs where I use the lib, but I don't need or use document relations. If you want to contribute better docs and/or code for this part, I am more than happy to accept pull requests.

If you want to work on it, just tell me so I can re-open the issue.